net/ipa/ipa_uc.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002
0003 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
0004  * Copyright (C) 2019-2020 Linaro Ltd.
0005  */
0006 #ifndef _IPA_UC_H_
0007 #define _IPA_UC_H_
0008
0009 struct ipa;
0010
0011 /**
0012  * ipa_uc_config() - Configure the IPA microcontroller subsystem
0013  * @ipa:    IPA pointer
0014  */
0015 void ipa_uc_config(struct ipa *ipa);
0016
0017 /**
0018  * ipa_uc_deconfig() - Inverse of ipa_uc_config()
0019  * @ipa:    IPA pointer
0020  */
0021 void ipa_uc_deconfig(struct ipa *ipa);
0022
0023 /**
0024  * ipa_uc_power() - Take a proxy power reference for the microcontroller
0025  * @ipa:    IPA pointer
0026  *
0027  * The first time the modem boots, it loads firmware for and starts the
0028  * IPA-resident microcontroller.  The microcontroller signals that it
0029  * has completed its initialization by sending an INIT_COMPLETED response
0030  * message to the AP.  The AP must ensure the IPA is powered until
0031  * it receives this message, and to do so we take a "proxy" clock
0032  * reference on its behalf here.  Once we receive the INIT_COMPLETED
0033  * message (in ipa_uc_response_hdlr()) we drop this power reference.
0034  */
0035 void ipa_uc_power(struct ipa *ipa);
0036
0037 /**
0038  * ipa_uc_panic_notifier()
0039  * @ipa:    IPA pointer
0040  *
0041  * Notifier function called when the system crashes, to inform the
0042  * microcontroller of the event.
0043  */
0044 void ipa_uc_panic_notifier(struct ipa *ipa);
0045
0046 #endif /* _IPA_UC_H_ */