soc/tegra/bpmp-abi.h

44  * @brief Messages sent to/from BPMP via IPC
56  * The CPU requests the BPMP to perform a particular service by
61  * The BPMP processes the data and replies with an IVC frame (on the
67  * BPMP can lead to BPMP eventually sending an MRQ message to the
69  * a thermal trip point, the BPMP may eventually send a single
168  * BPMP. Subject to change in future
216  * * Targets: BPMP
220  * Behavior is equivalent to a simple #MRQ_PING except that BPMP
256  * @brief Query BPMP firmware's tag (i.e. unique identifer)
262  * * Targets: BPMP
284  * @brief Query BPMP firmware's tag (i.e. unique identifier)
288  * * Targets: BPMP
310  * @brief Dynamically load a BPMP code module
315  * * Targets: BPMP
367  * * Targets: BPMP
396  * * Targets: BPMP
441  * * Targets: BPMP
509  * * Targets: BPMP
525 	 * The length of data[ ] is unknown to the BPMP core firmware
538 	 * The length of data[ ] is unknown to the BPMP core firmware
548  * @brief Interact with BPMP's debugfs file nodes
554  * * Targets: BPMP
563  * The BPMP firmware implements a pseudo-filesystem called
574  * BPMP firmware's ABI. debugfs files may be added or removed in any
694  * @brief Interact with BPMP's debugfs file nodes. Use message payload
701  * between BPMP and CPU until the transaction completes.
705  * * Targets: BPMP
882  * * Targets: BPMP
933  * Used by the sender of an #MRQ_RESET message to request BPMP to
982  * * Targets: BPMP
1048  * Processing an cmd_i2c_xfer_request::data_buf causes BPMP to execute
1076  *  -#BPMP_ENODEV: if cmd_i2c_xfer_request::bus_id is not supported by BPMP
1096  * * Targets: BPMP
1388  * * Targets: BPMP
1432  * * Targets: BPMP
1441  * Used by #MRQ_PG_UPDATE_STATE call to request BPMP to change the
1448 	 *  @details Ignored by many versions of the BPMP
1478  * @note BPMP-FW forcefully turns off some partitions as part of SC7 entry
1485  * * Targets: BPMP
1494 	 * @brief Check whether the BPMP driver supports the specified
1651  * @brief Interact with BPMP thermal framework
1661  * The BPMP firmware includes a thermal framework. Drivers within the
1662  * bpmp firmware register with the framework to provide thermal
1667  * hits the indicated temperature. The BPMP firmware uses this thermal
1672  * mrq_thermal_host_to_bpmp_request) to interact with the BPMP thermal
1676  * When a trip point set by the CPU gets crossed, BPMP firmware issues
1683 	 * @brief Check whether the BPMP driver supports the specified
1712 	 * temperature hits a trip point, the BPMP will send a message
1747 	/** @brief: number of supported host-to-bpmp commands. May
1759 	 * BPMP needs to supply request parameters. Host only needs to
1764 	/** @brief: number of supported bpmp-to-host commands. May
1771  * Host->BPMP request data for request type CMD_THERMAL_QUERY_ABI
1780  * Host->BPMP request data for request type CMD_THERMAL_GET_TEMP
1789  * BPMP->Host reply data for request CMD_THERMAL_GET_TEMP
1802  * Host->BPMP request data for request type CMD_THERMAL_SET_TRIP
1817  * BPMP->Host request data for request type CMD_THERMAL_HOST_TRIP_REACHED
1826  * BPMP->Host reply data for request type CMD_THERMAL_GET_NUM_ZONES
1836  * Host->BPMP request data for request type CMD_THERMAL_GET_THERMTRIP
1845  * BPMP->Host reply data for request CMD_THERMAL_GET_THERMTRIP
1854  * Host->BPMP request data.
1872  * BPMP->Host request data.
1885  * Data in reply to a Host->BPMP request.
1902  * * Targets: BPMP
1914  * from BPMP to memory space pointed by #addr. CCPLEX is responsible
1916  * appropriately map it for BPMP before sending the request.
1961  * * Targets: BPMP
1976  * 3. A bug is discovered in an existing implementation of the BPMP-FW
1988  * If ratchet is less than BPMP's #BPMP_ABI_RATCHET_VALUE, BPMP may
1990  * BPMP-FW cannot interoperate correctly with the requester. Requester
1991  * should cease further communication with BPMP.
2004  * against which BPMP firwmare was compiled.
2007  * the requster must either interoperate with BPMP according to an ABI
2009  * communication with BPMP.
2016 	/** @brief BPMP's ratchet value */
2028  * * Targets: BPMP
2066  * * Targets: BPMP
2108  * * Targets: BPMP
2113  * Queries from BPMP auto-CC3 configuration (allowed/not allowed) for a
2115  * device tree auto-CC3 settings, so that BPMP device tree is a single source of
2155  * * Targets: BPMP
2181  * @brief A ring buffer debug console for BPMP
2186  * BPMP-FW, the RX (receive) and TX (transmit) buffers. Characters can be read
2194  * BPMP
2203  * BPMP
2212 	 * @brief Check whether the BPMP driver supports the specified request
2220 	 * @brief Perform a read operation on the BPMP TX buffer
2226 	 * @brief Perform a write operation on the BPMP RX buffer
2244  * @brief Host->BPMP request data for request type
2259  * @brief Host->BPMP request data for request type #CMD_RINGBUF_CONSOLE_READ
2263 	 * @brief Number of bytes requested to be read from the BPMP TX buffer
2270  * @brief BPMP->Host response data for request type #CMD_RINGBUF_CONSOLE_READ
2273 	/** @brief The actual data read from the BPMP TX buffer */
2281  * @brief Host->BPMP request data for request type #CMD_RINGBUF_CONSOLE_WRITE
2284 	/** @brief The actual data to be written to the BPMP RX buffer */
2292  * @brief BPMP->Host response data for request type #CMD_RINGBUF_CONSOLE_WRITE
2295 	/** @brief Number of bytes of available space in the BPMP RX buffer */
2297 	/** @brief Number of bytes that were written to the BPMP RX buffer */
2308  * @brief BPMP->Host reply data for request type #CMD_RINGBUF_CONSOLE_GET_FIFO
2311 	/** @brief Physical address of the BPMP TX buffer */
2313 	/** @brief Physical address of the BPMP TX buffer head counter */
2315 	/** @brief Physical address of the BPMP TX buffer tail counter */
2317 	/** @brief Length of the BPMP TX buffer */
2323  * @brief Host->BPMP request data.
2344  * @brief Host->BPMP reply data
2359  * @brief Set a strap value controlled by BPMP
2364  * * Targets: BPMP
2375  * BPMP owns registers which act as straps to various units. It
2413  * * Targets: BPMP
2527  * * Targets: BPMP
2661  * * Targets: BPMP
2676 	 * -#BPMP_ENODEV if target EC is not owned by BPMP @n
2688 	 * -#BPMP_ENODEV if target EC is not owned by BPMP @n
2696 /** @brief BPMP ECs error types */
2952  * by BPMP.