Skip to content

L
linux
Commit 4bef358c authored by Timo Alho's avatar Timo Alho Committed by Thierry Reding
Browse files
Options

soc/tegra: bpmp: Update ABI header 

Update the firmware header file to a more recent version. The major
changes in the new version are:

 * add a new MRQ for firmware version query ABI and deprecates the old
 * add ABI to query Tegra194 CPU frequency limits
 * add ABI to control subset of PCIE UPHY state

The new header contains also some editorial changes to the
documentation.
Signed-off-by: default avatarTimo Alho <talho@nvidia.com>
Acked-by: default avatarSivaram Nair <sivaramn@nvidia.com>
Acked-by: default avatarJon Hunter <jonathanh@nvidia.com>
Signed-off-by: default avatarThierry Reding <treding@nvidia.com>
parent 2b86c11b
Hide whitespace changes
Inline Side-by-side
Showing with 947 additions and 241 deletions
include/soc/tegra/bpmp-abi.h
View file @ 4bef358c
/* /*
* Copyright (c) 2014-2016, NVIDIA CORPORATION. All rights reserved. * Copyright (c) 2014-2018, NVIDIA CORPORATION. All rights reserved.
* *
* This program is free software; you can redistribute it and/or modify it * This program is free software; you can redistribute it and/or modify it
* under the terms and conditions of the GNU General Public License, * under the terms and conditions of the GNU General Public License,
...@@ -40,7 +40,6 @@ ...@@ -40,7 +40,6 @@
* @file * @file
*/ */
/** /**
* @defgroup MRQ MRQ Messages * @defgroup MRQ MRQ Messages
* @brief Messages sent to/from BPMP via IPC * @brief Messages sent to/from BPMP via IPC
...@@ -53,7 +52,7 @@ ...@@ -53,7 +52,7 @@
*/ */
/** /**
* @addtogroup MRQ_Format Message Format * @addtogroup MRQ_Format
* @{ * @{
* The CPU requests the BPMP to perform a particular service by * The CPU requests the BPMP to perform a particular service by
* sending it an IVC frame containing a single MRQ message. An MRQ * sending it an IVC frame containing a single MRQ message. An MRQ
...@@ -76,7 +75,7 @@ ...@@ -76,7 +75,7 @@
/** /**
* @ingroup MRQ_Format * @ingroup MRQ_Format
* @brief header for an MRQ message * @brief Header for an MRQ message
* *
* Provides the MRQ number for the MRQ message: #mrq. The remainder of * Provides the MRQ number for the MRQ message: #mrq. The remainder of
* the MRQ message is a payload (immediately following the * the MRQ message is a payload (immediately following the
...@@ -86,7 +85,7 @@ struct mrq_request { ...@@ -86,7 +85,7 @@ struct mrq_request {
/** @brief MRQ number of the request */ /** @brief MRQ number of the request */
uint32_t mrq; uint32_t mrq;
/** /**
* @brief flags providing follow up directions to the receiver * @brief Flags providing follow up directions to the receiver
* *
* | Bit | Description | * | Bit | Description |
* |-----|--------------------------------------------| * |-----|--------------------------------------------|
...@@ -98,7 +97,7 @@ struct mrq_request { ...@@ -98,7 +97,7 @@ struct mrq_request {
/** /**
* @ingroup MRQ_Format * @ingroup MRQ_Format
* @brief header for an MRQ response * @brief Header for an MRQ response
* *
* Provides an error code for the associated MRQ message. The * Provides an error code for the associated MRQ message. The
* remainder of the MRQ response is a payload (immediately following * remainder of the MRQ response is a payload (immediately following
...@@ -106,9 +105,9 @@ struct mrq_request { ...@@ -106,9 +105,9 @@ struct mrq_request {
* mrq_request::mrq * mrq_request::mrq
*/ */
struct mrq_response { struct mrq_response {
/** @brief error code for the MRQ request itself */ /** @brief Error code for the MRQ request itself */
int32_t err; int32_t err;
/** @brief reserved for future use */ /** @brief Reserved for future use */
uint32_t flags; uint32_t flags;
} __ABI_PACKED; } __ABI_PACKED;
...@@ -152,6 +151,14 @@ struct mrq_response { ...@@ -152,6 +151,14 @@ struct mrq_response {
#define MRQ_TRACE_ITER 64 #define MRQ_TRACE_ITER 64
#define MRQ_RINGBUF_CONSOLE 65 #define MRQ_RINGBUF_CONSOLE 65
#define MRQ_PG 66 #define MRQ_PG 66
#define MRQ_CPU_NDIV_LIMITS 67
#define MRQ_STRAP 68
#define MRQ_UPHY 69
#define MRQ_CPU_AUTO_CC3 70
#define MRQ_QUERY_FW_TAG 71
#define MRQ_FMON 72
#define MRQ_EC 73
#define MRQ_FBVOLT_STATUS 74
/** @} */ /** @} */
...@@ -160,31 +167,35 @@ struct mrq_response { ...@@ -160,31 +167,35 @@ struct mrq_response {
* @brief Maximum MRQ code to be sent by CPU software to * @brief Maximum MRQ code to be sent by CPU software to
* BPMP. Subject to change in future * BPMP. Subject to change in future
*/ */
#define MAX_CPU_MRQ_ID 66 #define MAX_CPU_MRQ_ID 74
/** /**
* @addtogroup MRQ_Payloads Message Payloads * @addtogroup MRQ_Payloads
* @{ * @{
* @defgroup Ping * @defgroup Ping Ping
* @defgroup Query_Tag Query Tag * @defgroup Query_Tag Query Tag
* @defgroup Module Loadable Modules * @defgroup Module Loadable Modules
* @defgroup Trace * @defgroup Trace Trace
* @defgroup Debugfs * @defgroup Debugfs Debug File System
* @defgroup Reset * @defgroup Reset Reset
* @defgroup I2C * @defgroup I2C I2C
* @defgroup Clocks * @defgroup Clocks Clocks
* @defgroup ABI_info ABI Info * @defgroup ABI_info ABI Info
* @defgroup MC_Flush MC Flush * @defgroup Powergating Power Gating
* @defgroup Powergating * @defgroup Thermal Thermal
* @defgroup Thermal
* @defgroup Vhint CPU Voltage hint * @defgroup Vhint CPU Voltage hint
* @defgroup MRQ_Deprecated Deprecated MRQ messages * @defgroup EMC EMC
* @defgroup EMC * @defgroup CPU NDIV Limits
* @defgroup RingbufConsole * @defgroup RingbufConsole Ring Buffer Console
* @defgroup Strap Straps
* @defgroup UPHY UPHY
* @defgroup CC3 Auto-CC3
* @defgroup FMON FMON
* @defgroup EC EC
* @defgroup Fbvolt_status Fuse Burn Voltage Status
* @} * @}
*/ */
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_PING * @def MRQ_PING
...@@ -214,20 +225,20 @@ struct mrq_response { ...@@ -214,20 +225,20 @@ struct mrq_response {
/** /**
* @ingroup Ping * @ingroup Ping
* @brief request with #MRQ_PING * @brief Request with #MRQ_PING
* *
* Used by the sender of an #MRQ_PING message to request a pong from * Used by the sender of an #MRQ_PING message to request a pong from
* recipient. The response from the recipient is computed based on * recipient. The response from the recipient is computed based on
* #challenge. * #challenge.
*/ */
struct mrq_ping_request { struct mrq_ping_request {
/** @brief arbitrarily chosen value */ /** @brief Arbitrarily chosen value */
uint32_t challenge; uint32_t challenge;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Ping * @ingroup Ping
* @brief response to #MRQ_PING * @brief Response to #MRQ_PING
* *
* Sent in response to an #MRQ_PING message. #reply should be the * Sent in response to an #MRQ_PING message. #reply should be the
* mrq_ping_request challenge left shifted by 1 with the carry-bit * mrq_ping_request challenge left shifted by 1 with the carry-bit
...@@ -235,14 +246,16 @@ struct mrq_ping_request { ...@@ -235,14 +246,16 @@ struct mrq_ping_request {
* *
*/ */
struct mrq_ping_response { struct mrq_ping_response {
/** @brief response to the MRQ_PING challege */ /** @brief Response to the MRQ_PING challege */
uint32_t reply; uint32_t reply;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_QUERY_TAG * @def MRQ_QUERY_TAG
* @brief Query BPMP firmware's tag (i.e. version information) * @brief Query BPMP firmware's tag (i.e. unique identifer)
*
* @deprecated Use #MRQ_QUERY_FW_TAG instead.
* *
* * Platforms: All * * Platforms: All
* * Initiators: CCPLEX * * Initiators: CCPLEX
...@@ -254,25 +267,50 @@ struct mrq_ping_response { ...@@ -254,25 +267,50 @@ struct mrq_ping_response {
/** /**
* @ingroup Query_Tag * @ingroup Query_Tag
* @brief request with #MRQ_QUERY_TAG * @brief Request with #MRQ_QUERY_TAG
*
* Used by #MRQ_QUERY_TAG call to ask BPMP to fill in the memory
* pointed by #addr with BPMP firmware header.
* *
* The sender is reponsible for ensuring that #addr is mapped in to * @deprecated This structure will be removed in future version.
* the recipient's address map. * Use MRQ_QUERY_FW_TAG instead.
*/ */
struct mrq_query_tag_request { struct mrq_query_tag_request {
/** @brief base address to store the firmware header */ /** @brief Base address to store the firmware tag */
uint32_t addr; uint32_t addr;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_MODULE_LOAD * @def MRQ_QUERY_FW_TAG
* @brief dynamically load a BPMP code module * @brief Query BPMP firmware's tag (i.e. unique identifier)
* *
* * Platforms: All * * Platforms: All
* * Initiators: Any
* * Targets: BPMP
* * Request Payload: N/A
* * Response Payload: @ref mrq_query_fw_tag_response
*
*/
/**
* @ingroup Query_Tag
* @brief Response to #MRQ_QUERY_FW_TAG
*
* Sent in response to #MRQ_QUERY_FW_TAG message. #tag contains the unique
* identifier for the version of firmware issuing the reply.
*
*/
struct mrq_query_fw_tag_response {
/** @brief Array to store tag information */
uint8_t tag[32];
} __ABI_PACKED;
/**
* @ingroup MRQ_Codes
* @def MRQ_MODULE_LOAD
* @brief Dynamically load a BPMP code module
*
* * Platforms: T210, T214, T186
* @cond (bpmp_t210 || bpmp_t214 || bpmp_t186)
* * Initiators: CCPLEX * * Initiators: CCPLEX
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_module_load_request * * Request Payload: @ref mrq_module_load_request
...@@ -284,7 +322,7 @@ struct mrq_query_tag_request { ...@@ -284,7 +322,7 @@ struct mrq_query_tag_request {
/** /**
* @ingroup Module * @ingroup Module
* @brief request with #MRQ_MODULE_LOAD * @brief Request with #MRQ_MODULE_LOAD
* *
* Used by #MRQ_MODULE_LOAD calls to ask the recipient to dynamically * Used by #MRQ_MODULE_LOAD calls to ask the recipient to dynamically
* load the code located at #phys_addr and having size #size * load the code located at #phys_addr and having size #size
...@@ -300,29 +338,31 @@ struct mrq_query_tag_request { ...@@ -300,29 +338,31 @@ struct mrq_query_tag_request {
* *
*/ */
struct mrq_module_load_request { struct mrq_module_load_request {
/** @brief base address of the code to load. Treated as (void *) */ /** @brief Base address of the code to load. Treated as (void *) */
uint32_t phys_addr; /* (void *) */ uint32_t phys_addr; /* (void *) */
/** @brief size in bytes of code to load */ /** @brief Size in bytes of code to load */
uint32_t size; uint32_t size;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Module * @ingroup Module
* @brief response to #MRQ_MODULE_LOAD * @brief Response to #MRQ_MODULE_LOAD
* *
* @todo document mrq_response::err * @todo document mrq_response::err
*/ */
struct mrq_module_load_response { struct mrq_module_load_response {
/** @brief handle to the loaded module */ /** @brief Handle to the loaded module */
uint32_t base; uint32_t base;
} __ABI_PACKED; } __ABI_PACKED;
/** @endcond*/
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_MODULE_UNLOAD * @def MRQ_MODULE_UNLOAD
* @brief unload a previously loaded code module * @brief Unload a previously loaded code module
* *
* * Platforms: All * * Platforms: T210, T214, T186
* @cond (bpmp_t210 || bpmp_t214 || bpmp_t186)
* * Initiators: CCPLEX * * Initiators: CCPLEX
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_module_unload_request * * Request Payload: @ref mrq_module_unload_request
...@@ -333,20 +373,21 @@ struct mrq_module_load_response { ...@@ -333,20 +373,21 @@ struct mrq_module_load_response {
/** /**
* @ingroup Module * @ingroup Module
* @brief request with #MRQ_MODULE_UNLOAD * @brief Request with #MRQ_MODULE_UNLOAD
* *
* Used by #MRQ_MODULE_UNLOAD calls to request that a previously loaded * Used by #MRQ_MODULE_UNLOAD calls to request that a previously loaded
* module be unloaded. * module be unloaded.
*/ */
struct mrq_module_unload_request { struct mrq_module_unload_request {
/** @brief handle of the module to unload */ /** @brief Handle of the module to unload */
uint32_t base; uint32_t base;
} __ABI_PACKED; } __ABI_PACKED;
/** @endcond*/
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_TRACE_MODIFY * @def MRQ_TRACE_MODIFY
* @brief modify the set of enabled trace events * @brief Modify the set of enabled trace events
* *
* * Platforms: All * * Platforms: All
* * Initiators: CCPLEX * * Initiators: CCPLEX
...@@ -359,22 +400,22 @@ struct mrq_module_unload_request { ...@@ -359,22 +400,22 @@ struct mrq_module_unload_request {
/** /**
* @ingroup Trace * @ingroup Trace
* @brief request with #MRQ_TRACE_MODIFY * @brief Request with #MRQ_TRACE_MODIFY
* *
* Used by %MRQ_TRACE_MODIFY calls to enable or disable specify trace * Used by %MRQ_TRACE_MODIFY calls to enable or disable specify trace
* events. #set takes precedence for any bit set in both #set and * events. #set takes precedence for any bit set in both #set and
* #clr. * #clr.
*/ */
struct mrq_trace_modify_request { struct mrq_trace_modify_request {
/** @brief bit mask of trace events to disable */ /** @brief Bit mask of trace events to disable */
uint32_t clr; uint32_t clr;
/** @brief bit mask of trace events to enable */ /** @brief Bit mask of trace events to enable */
uint32_t set; uint32_t set;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Trace * @ingroup Trace
* @brief response to #MRQ_TRACE_MODIFY * @brief Response to #MRQ_TRACE_MODIFY
* *
* Sent in repsonse to an #MRQ_TRACE_MODIFY message. #mask reflects the * Sent in repsonse to an #MRQ_TRACE_MODIFY message. #mask reflects the
* state of which events are enabled after the recipient acted on the * state of which events are enabled after the recipient acted on the
...@@ -382,7 +423,7 @@ struct mrq_trace_modify_request { ...@@ -382,7 +423,7 @@ struct mrq_trace_modify_request {
* *
*/ */
struct mrq_trace_modify_response { struct mrq_trace_modify_response {
/** @brief bit mask of trace event enable states */ /** @brief Bit mask of trace event enable states */
uint32_t mask; uint32_t mask;
} __ABI_PACKED; } __ABI_PACKED;
...@@ -407,7 +448,7 @@ struct mrq_trace_modify_response { ...@@ -407,7 +448,7 @@ struct mrq_trace_modify_response {
/** /**
* @ingroup Trace * @ingroup Trace
* @brief request with #MRQ_WRITE_TRACE * @brief Request with #MRQ_WRITE_TRACE
* *
* Used by MRQ_WRITE_TRACE calls to ask the recipient to copy trace * Used by MRQ_WRITE_TRACE calls to ask the recipient to copy trace
* data from the recipient's local buffer to the output buffer. #area * data from the recipient's local buffer to the output buffer. #area
...@@ -420,22 +461,22 @@ struct mrq_trace_modify_response { ...@@ -420,22 +461,22 @@ struct mrq_trace_modify_response {
* overwrites. * overwrites.
*/ */
struct mrq_write_trace_request { struct mrq_write_trace_request {
/** @brief base address of output buffer */ /** @brief Base address of output buffer */
uint32_t area; uint32_t area;
/** @brief size in bytes of the output buffer */ /** @brief Size in bytes of the output buffer */
uint32_t size; uint32_t size;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Trace * @ingroup Trace
* @brief response to #MRQ_WRITE_TRACE * @brief Response to #MRQ_WRITE_TRACE
* *
* Once this response is sent, the respondent will not access the * Once this response is sent, the respondent will not access the
* output buffer further. * output buffer further.
*/ */
struct mrq_write_trace_response { struct mrq_write_trace_response {
/** /**
* @brief flag whether more data remains in local buffer * @brief Flag whether more data remains in local buffer
* *
* Value is 1 if the entire local trace buffer has been * Value is 1 if the entire local trace buffer has been
* drained to the outputbuffer. Value is 0 otherwise. * drained to the outputbuffer. Value is 0 otherwise.
...@@ -456,9 +497,10 @@ struct mrq_threaded_ping_response { ...@@ -456,9 +497,10 @@ struct mrq_threaded_ping_response {
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_MODULE_MAIL * @def MRQ_MODULE_MAIL
* @brief send a message to a loadable module * @brief Send a message to a loadable module
* *
* * Platforms: All * * Platforms: T210, T214, T186
* @cond (bpmp_t210 || bpmp_t214 || bpmp_t186)
* * Initiators: Any * * Initiators: Any
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_module_mail_request * * Request Payload: @ref mrq_module_mail_request
...@@ -469,12 +511,12 @@ struct mrq_threaded_ping_response { ...@@ -469,12 +511,12 @@ struct mrq_threaded_ping_response {
/** /**
* @ingroup Module * @ingroup Module
* @brief request with #MRQ_MODULE_MAIL * @brief Request with #MRQ_MODULE_MAIL
*/ */
struct mrq_module_mail_request { struct mrq_module_mail_request {
/** @brief handle to the previously loaded module */ /** @brief Handle to the previously loaded module */
uint32_t base; uint32_t base;
/** @brief module-specific mail payload /** @brief Module-specific mail payload
* *
* The length of data[ ] is unknown to the BPMP core firmware * The length of data[ ] is unknown to the BPMP core firmware
* but it is limited to the size of an IPC message. * but it is limited to the size of an IPC message.
...@@ -484,23 +526,24 @@ struct mrq_module_mail_request { ...@@ -484,23 +526,24 @@ struct mrq_module_mail_request {
/** /**
* @ingroup Module * @ingroup Module
* @brief response to #MRQ_MODULE_MAIL * @brief Response to #MRQ_MODULE_MAIL
*/ */
struct mrq_module_mail_response { struct mrq_module_mail_response {
/** @brief module-specific mail payload /** @brief Module-specific mail payload
* *
* The length of data[ ] is unknown to the BPMP core firmware * The length of data[ ] is unknown to the BPMP core firmware
* but it is limited to the size of an IPC message. * but it is limited to the size of an IPC message.
*/ */
uint8_t data[EMPTY_ARRAY]; uint8_t data[EMPTY_ARRAY];
} __ABI_PACKED; } __ABI_PACKED;
/** @endcond */
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_DEBUGFS * @def MRQ_DEBUGFS
* @brief Interact with BPMP's debugfs file nodes * @brief Interact with BPMP's debugfs file nodes
* *
* * Platforms: T186 * * Platforms: T186, T194
* * Initiators: Any * * Initiators: Any
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_debugfs_request * * Request Payload: @ref mrq_debugfs_request
...@@ -529,65 +572,70 @@ struct mrq_module_mail_response { ...@@ -529,65 +572,70 @@ struct mrq_module_mail_response {
* *
* @} * @}
*/ */
/** @ingroup Debugfs */ /** @ingroup Debugfs */
enum mrq_debugfs_commands { enum mrq_debugfs_commands {
/** @brief Perform read */
CMD_DEBUGFS_READ = 1, CMD_DEBUGFS_READ = 1,
/** @brief Perform write */
CMD_DEBUGFS_WRITE = 2, CMD_DEBUGFS_WRITE = 2,
/** @brief Perform dumping directory */
CMD_DEBUGFS_DUMPDIR = 3, CMD_DEBUGFS_DUMPDIR = 3,
/** @brief Not a command */
CMD_DEBUGFS_MAX CMD_DEBUGFS_MAX
}; };
/** /**
* @ingroup Debugfs * @ingroup Debugfs
* @brief parameters for CMD_DEBUGFS_READ/WRITE command * @brief Parameters for CMD_DEBUGFS_READ/WRITE command
*/ */
struct cmd_debugfs_fileop_request { struct cmd_debugfs_fileop_request {
/** @brief physical address pointing at filename */ /** @brief Physical address pointing at filename */
uint32_t fnameaddr; uint32_t fnameaddr;
/** @brief length in bytes of filename buffer */ /** @brief Length in bytes of filename buffer */
uint32_t fnamelen; uint32_t fnamelen;
/** @brief physical address pointing to data buffer */ /** @brief Physical address pointing to data buffer */
uint32_t dataaddr; uint32_t dataaddr;
/** @brief length in bytes of data buffer */ /** @brief Length in bytes of data buffer */
uint32_t datalen; uint32_t datalen;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Debugfs * @ingroup Debugfs
* @brief parameters for CMD_DEBUGFS_READ/WRITE command * @brief Parameters for CMD_DEBUGFS_READ/WRITE command
*/ */
struct cmd_debugfs_dumpdir_request { struct cmd_debugfs_dumpdir_request {
/** @brief physical address pointing to data buffer */ /** @brief Physical address pointing to data buffer */
uint32_t dataaddr; uint32_t dataaddr;
/** @brief length in bytes of data buffer */ /** @brief Length in bytes of data buffer */
uint32_t datalen; uint32_t datalen;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Debugfs * @ingroup Debugfs
* @brief response data for CMD_DEBUGFS_READ/WRITE command * @brief Response data for CMD_DEBUGFS_READ/WRITE command
*/ */
struct cmd_debugfs_fileop_response { struct cmd_debugfs_fileop_response {
/** @brief always 0 */ /** @brief Always 0 */
uint32_t reserved; uint32_t reserved;
/** @brief number of bytes read from or written to data buffer */ /** @brief Number of bytes read from or written to data buffer */
uint32_t nbytes; uint32_t nbytes;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Debugfs * @ingroup Debugfs
* @brief response data for CMD_DEBUGFS_DUMPDIR command * @brief Response data for CMD_DEBUGFS_DUMPDIR command
*/ */
struct cmd_debugfs_dumpdir_response { struct cmd_debugfs_dumpdir_response {
/** @brief always 0 */ /** @brief Always 0 */
uint32_t reserved; uint32_t reserved;
/** @brief number of bytes read from or written to data buffer */ /** @brief Number of bytes read from or written to data buffer */
uint32_t nbytes; uint32_t nbytes;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Debugfs * @ingroup Debugfs
* @brief request with #MRQ_DEBUGFS. * @brief Request with #MRQ_DEBUGFS.
* *
* The sender of an MRQ_DEBUGFS message uses #cmd to specify a debugfs * The sender of an MRQ_DEBUGFS message uses #cmd to specify a debugfs
* command to execute. Legal commands are the values of @ref * command to execute. Legal commands are the values of @ref
...@@ -601,6 +649,7 @@ struct cmd_debugfs_dumpdir_response { ...@@ -601,6 +649,7 @@ struct cmd_debugfs_dumpdir_response {
* |CMD_DEBUGFS_DUMPDIR|dumpdir| * |CMD_DEBUGFS_DUMPDIR|dumpdir|
*/ */
struct mrq_debugfs_request { struct mrq_debugfs_request {
/** @brief Sub-command (@ref mrq_debugfs_commands) */
uint32_t cmd; uint32_t cmd;
union { union {
struct cmd_debugfs_fileop_request fop; struct cmd_debugfs_fileop_request fop;
...@@ -612,14 +661,14 @@ struct mrq_debugfs_request { ...@@ -612,14 +661,14 @@ struct mrq_debugfs_request {
* @ingroup Debugfs * @ingroup Debugfs
*/ */
struct mrq_debugfs_response { struct mrq_debugfs_response {
/** @brief always 0 */ /** @brief Always 0 */
int32_t reserved; int32_t reserved;
union { union {
/** @brief response data for CMD_DEBUGFS_READ OR /** @brief Response data for CMD_DEBUGFS_READ OR
* CMD_DEBUGFS_WRITE command * CMD_DEBUGFS_WRITE command
*/ */
struct cmd_debugfs_fileop_response fop; struct cmd_debugfs_fileop_response fop;
/** @brief response data for CMD_DEBUGFS_DUMPDIR command */ /** @brief Response data for CMD_DEBUGFS_DUMPDIR command */
struct cmd_debugfs_dumpdir_response dumpdir; struct cmd_debugfs_dumpdir_response dumpdir;
} __UNION_ANON; } __UNION_ANON;
} __ABI_PACKED; } __ABI_PACKED;
...@@ -633,57 +682,58 @@ struct mrq_debugfs_response { ...@@ -633,57 +682,58 @@ struct mrq_debugfs_response {
#define DEBUGFS_S_IWUSR (1 << 7) #define DEBUGFS_S_IWUSR (1 << 7)
/** @} */ /** @} */
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_RESET * @def MRQ_RESET
* @brief reset an IP block * @brief Reset an IP block
* *
* * Platforms: T186 * * Platforms: T186, T194
* * Initiators: Any * * Initiators: Any
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_reset_request * * Request Payload: @ref mrq_reset_request
* * Response Payload: @ref mrq_reset_response * * Response Payload: @ref mrq_reset_response
*
* @addtogroup Reset
* @{
*/ */
/**
* @ingroup Reset
*/
enum mrq_reset_commands { enum mrq_reset_commands {
/** @brief Assert module reset */
CMD_RESET_ASSERT = 1, CMD_RESET_ASSERT = 1,
/** @brief Deassert module reset */
CMD_RESET_DEASSERT = 2, CMD_RESET_DEASSERT = 2,
/** @brief Assert and deassert the module reset */
CMD_RESET_MODULE = 3, CMD_RESET_MODULE = 3,
/** @brief Get the highest reset ID */
CMD_RESET_GET_MAX_ID = 4, CMD_RESET_GET_MAX_ID = 4,
CMD_RESET_MAX, /* not part of ABI and subject to change */ /** @brief Not part of ABI and subject to change */
CMD_RESET_MAX,
}; };
/** /**
* @ingroup Reset * @brief Request with MRQ_RESET
* @brief request with MRQ_RESET
* *
* Used by the sender of an #MRQ_RESET message to request BPMP to * Used by the sender of an #MRQ_RESET message to request BPMP to
* assert or or deassert a given reset line. * assert or or deassert a given reset line.
*/ */
struct mrq_reset_request { struct mrq_reset_request {
/** @brief reset action to perform (@enum mrq_reset_commands) */ /** @brief Reset action to perform (@ref mrq_reset_commands) */
uint32_t cmd; uint32_t cmd;
/** @brief id of the reset to affected */ /** @brief Id of the reset to affected */
uint32_t reset_id; uint32_t reset_id;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Reset
* @brief Response for MRQ_RESET sub-command CMD_RESET_GET_MAX_ID. When * @brief Response for MRQ_RESET sub-command CMD_RESET_GET_MAX_ID. When
* this sub-command is not supported, firmware will return -BPMP_EBADCMD * this sub-command is not supported, firmware will return -BPMP_EBADCMD
* in mrq_response::err. * in mrq_response::err.
*/ */
struct cmd_reset_get_max_id_response { struct cmd_reset_get_max_id_response {
/** @brief max reset id */ /** @brief Max reset id */
uint32_t max_id; uint32_t max_id;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Reset
* @brief Response with MRQ_RESET * @brief Response with MRQ_RESET
* *
* Each sub-command supported by @ref mrq_reset_request may return * Each sub-command supported by @ref mrq_reset_request may return
...@@ -703,32 +753,25 @@ struct mrq_reset_response { ...@@ -703,32 +753,25 @@ struct mrq_reset_response {
} __UNION_ANON; } __UNION_ANON;
} __ABI_PACKED; } __ABI_PACKED;
/** @} */
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_I2C * @def MRQ_I2C
* @brief issue an i2c transaction * @brief Issue an i2c transaction
* *
* * Platforms: T186 * * Platforms: T186, T194
* * Initiators: Any * * Initiators: Any
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_i2c_request * * Request Payload: @ref mrq_i2c_request
* * Response Payload: @ref mrq_i2c_response * * Response Payload: @ref mrq_i2c_response
*/ *
/**
* @addtogroup I2C * @addtogroup I2C
* @{ * @{
*/ */
#define TEGRA_I2C_IPC_MAX_IN_BUF_SIZE (MSG_DATA_MIN_SZ - 12) #define TEGRA_I2C_IPC_MAX_IN_BUF_SIZE (MSG_DATA_MIN_SZ - 12)
#define TEGRA_I2C_IPC_MAX_OUT_BUF_SIZE (MSG_DATA_MIN_SZ - 4) #define TEGRA_I2C_IPC_MAX_OUT_BUF_SIZE (MSG_DATA_MIN_SZ - 4)
/** @} */
/**
* @ingroup I2C
* @name Serial I2C flags
* Use these flags with serial_i2c_request::flags
* @{
*/
#define SERIALI2C_TEN 0x0010 #define SERIALI2C_TEN 0x0010
#define SERIALI2C_RD 0x0001 #define SERIALI2C_RD 0x0001
#define SERIALI2C_STOP 0x8000 #define SERIALI2C_STOP 0x8000
...@@ -737,15 +780,13 @@ struct mrq_reset_response { ...@@ -737,15 +780,13 @@ struct mrq_reset_response {
#define SERIALI2C_IGNORE_NAK 0x1000 #define SERIALI2C_IGNORE_NAK 0x1000
#define SERIALI2C_NO_RD_ACK 0x0800 #define SERIALI2C_NO_RD_ACK 0x0800
#define SERIALI2C_RECV_LEN 0x0400 #define SERIALI2C_RECV_LEN 0x0400
/** @} */
/** @ingroup I2C */
enum { enum {
CMD_I2C_XFER = 1 CMD_I2C_XFER = 1
}; };
/** /**
* @ingroup I2C * @brief Serializable i2c request
* @brief serializable i2c request
* *
* Instances of this structure are packed (little-endian) into * Instances of this structure are packed (little-endian) into
* cmd_i2c_xfer_request::data_buf. Each instance represents a single * cmd_i2c_xfer_request::data_buf. Each instance represents a single
...@@ -762,80 +803,75 @@ enum { ...@@ -762,80 +803,75 @@ enum {
struct serial_i2c_request { struct serial_i2c_request {
/** @brief I2C slave address */ /** @brief I2C slave address */
uint16_t addr; uint16_t addr;
/** @brief bitmask of SERIALI2C_ flags */ /** @brief Bitmask of SERIALI2C_ flags */
uint16_t flags; uint16_t flags;
/** @brief length of I2C transaction in bytes */ /** @brief Length of I2C transaction in bytes */
uint16_t len; uint16_t len;
/** @brief for write transactions only, #len bytes of data */ /** @brief For write transactions only, #len bytes of data */
uint8_t data[]; uint8_t data[];
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup I2C * @brief Trigger one or more i2c transactions
* @brief trigger one or more i2c transactions
*/ */
struct cmd_i2c_xfer_request { struct cmd_i2c_xfer_request {
/** @brief valid bus number from mach-t186/i2c-t186.h*/ /** @brief Valid bus number from @ref bpmp_i2c_ids*/
uint32_t bus_id; uint32_t bus_id;
/** @brief count of valid bytes in #data_buf*/ /** @brief Count of valid bytes in #data_buf*/
uint32_t data_size; uint32_t data_size;
/** @brief serialized packed instances of @ref serial_i2c_request*/ /** @brief Serialized packed instances of @ref serial_i2c_request*/
uint8_t data_buf[TEGRA_I2C_IPC_MAX_IN_BUF_SIZE]; uint8_t data_buf[TEGRA_I2C_IPC_MAX_IN_BUF_SIZE];
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup I2C * @brief Container for data read from the i2c bus
* @brief container for data read from the i2c bus
* *
* Processing an cmd_i2c_xfer_request::data_buf causes BPMP to execute * Processing an cmd_i2c_xfer_request::data_buf causes BPMP to execute
* zero or more I2C reads. The data read from the bus is serialized * zero or more I2C reads. The data read from the bus is serialized
* into #data_buf. * into #data_buf.
*/ */
struct cmd_i2c_xfer_response { struct cmd_i2c_xfer_response {
/** @brief count of valid bytes in #data_buf*/ /** @brief Count of valid bytes in #data_buf*/
uint32_t data_size; uint32_t data_size;
/** @brief i2c read data */ /** @brief I2c read data */
uint8_t data_buf[TEGRA_I2C_IPC_MAX_OUT_BUF_SIZE]; uint8_t data_buf[TEGRA_I2C_IPC_MAX_OUT_BUF_SIZE];
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup I2C * @brief Request with #MRQ_I2C
* @brief request with #MRQ_I2C
*/ */
struct mrq_i2c_request { struct mrq_i2c_request {
/** @brief always CMD_I2C_XFER (i.e. 1) */ /** @brief Always CMD_I2C_XFER (i.e. 1) */
uint32_t cmd; uint32_t cmd;
/** @brief parameters of the transfer request */ /** @brief Parameters of the transfer request */
struct cmd_i2c_xfer_request xfer; struct cmd_i2c_xfer_request xfer;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup I2C * @brief Response to #MRQ_I2C
* @brief response to #MRQ_I2C
*/ */
struct mrq_i2c_response { struct mrq_i2c_response {
struct cmd_i2c_xfer_response xfer; struct cmd_i2c_xfer_response xfer;
} __ABI_PACKED; } __ABI_PACKED;
/** @} */
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_CLK * @def MRQ_CLK
* @brief Perform a clock operation
* *
* * Platforms: T186 * * Platforms: T186, T194
* * Initiators: Any * * Initiators: Any
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_clk_request * * Request Payload: @ref mrq_clk_request
* * Response Payload: @ref mrq_clk_response * * Response Payload: @ref mrq_clk_response
*
* @addtogroup Clocks * @addtogroup Clocks
* @{ * @{
*/ */
/**
* @name MRQ_CLK sub-commands
* @{
*/
enum { enum {
CMD_CLK_GET_RATE = 1, CMD_CLK_GET_RATE = 1,
CMD_CLK_SET_RATE = 2, CMD_CLK_SET_RATE = 2,
...@@ -847,20 +883,13 @@ enum { ...@@ -847,20 +883,13 @@ enum {
CMD_CLK_DISABLE = 8, CMD_CLK_DISABLE = 8,
CMD_CLK_GET_ALL_INFO = 14, CMD_CLK_GET_ALL_INFO = 14,
CMD_CLK_GET_MAX_CLK_ID = 15, CMD_CLK_GET_MAX_CLK_ID = 15,
CMD_CLK_GET_FMAX_AT_VMIN = 16,
CMD_CLK_MAX, CMD_CLK_MAX,
}; };
/** @} */
/**
* @name MRQ_CLK properties
* Flag bits for cmd_clk_properties_response::flags and
* cmd_clk_get_all_info_response::flags
* @{
*/
#define BPMP_CLK_HAS_MUX (1 << 0) #define BPMP_CLK_HAS_MUX (1 << 0)
#define BPMP_CLK_HAS_SET_RATE (1 << 1) #define BPMP_CLK_HAS_SET_RATE (1 << 1)
#define BPMP_CLK_IS_ROOT (1 << 2) #define BPMP_CLK_IS_ROOT (1 << 2)
/** @} */
#define MRQ_CLK_NAME_MAXLEN 40 #define MRQ_CLK_NAME_MAXLEN 40
#define MRQ_CLK_MAX_PARENTS 16 #define MRQ_CLK_MAX_PARENTS 16
...@@ -959,11 +988,19 @@ struct cmd_clk_get_max_clk_id_request { ...@@ -959,11 +988,19 @@ struct cmd_clk_get_max_clk_id_request {
struct cmd_clk_get_max_clk_id_response { struct cmd_clk_get_max_clk_id_response {
uint32_t max_id; uint32_t max_id;
} __ABI_PACKED; } __ABI_PACKED;
/** @} */
/** @private */
struct cmd_clk_get_fmax_at_vmin_request {
EMPTY
} __ABI_PACKED;
struct cmd_clk_get_fmax_at_vmin_response {
int64_t rate;
} __ABI_PACKED;
/** /**
* @ingroup Clocks * @ingroup Clocks
* @brief request with #MRQ_CLK * @brief Request with #MRQ_CLK
* *
* Used by the sender of an #MRQ_CLK message to control clocks. The * Used by the sender of an #MRQ_CLK message to control clocks. The
* clk_request is split into several sub-commands. Some sub-commands * clk_request is split into several sub-commands. Some sub-commands
...@@ -982,11 +1019,13 @@ struct cmd_clk_get_max_clk_id_response { ...@@ -982,11 +1019,13 @@ struct cmd_clk_get_max_clk_id_response {
* |CMD_CLK_DISABLE |- | * |CMD_CLK_DISABLE |- |
* |CMD_CLK_GET_ALL_INFO |- | * |CMD_CLK_GET_ALL_INFO |- |
* |CMD_CLK_GET_MAX_CLK_ID |- | * |CMD_CLK_GET_MAX_CLK_ID |- |
* |CMD_CLK_GET_FMAX_AT_VMIN |-
* |
* *
*/ */
struct mrq_clk_request { struct mrq_clk_request {
/** @brief sub-command and clock id concatenated to 32-bit word. /** @brief Sub-command and clock id concatenated to 32-bit word.
* - bits[31..24] is the sub-cmd. * - bits[31..24] is the sub-cmd.
* - bits[23..0] is the clock id * - bits[23..0] is the clock id
*/ */
...@@ -1010,12 +1049,14 @@ struct mrq_clk_request { ...@@ -1010,12 +1049,14 @@ struct mrq_clk_request {
struct cmd_clk_get_all_info_request clk_get_all_info; struct cmd_clk_get_all_info_request clk_get_all_info;
/** @private */ /** @private */
struct cmd_clk_get_max_clk_id_request clk_get_max_clk_id; struct cmd_clk_get_max_clk_id_request clk_get_max_clk_id;
/** @private */
struct cmd_clk_get_fmax_at_vmin_request clk_get_fmax_at_vmin;
} __UNION_ANON; } __UNION_ANON;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Clocks * @ingroup Clocks
* @brief response to MRQ_CLK * @brief Response to MRQ_CLK
* *
* Each sub-command supported by @ref mrq_clk_request may return * Each sub-command supported by @ref mrq_clk_request may return
* sub-command-specific data. Some do and some do not as indicated in * sub-command-specific data. Some do and some do not as indicated in
...@@ -1033,6 +1074,7 @@ struct mrq_clk_request { ...@@ -1033,6 +1074,7 @@ struct mrq_clk_request {
* |CMD_CLK_DISABLE |- | * |CMD_CLK_DISABLE |- |
* |CMD_CLK_GET_ALL_INFO |clk_get_all_info | * |CMD_CLK_GET_ALL_INFO |clk_get_all_info |
* |CMD_CLK_GET_MAX_CLK_ID |clk_get_max_id | * |CMD_CLK_GET_MAX_CLK_ID |clk_get_max_id |
* |CMD_CLK_GET_FMAX_AT_VMIN |clk_get_fmax_at_vmin |
* *
*/ */
...@@ -1050,13 +1092,16 @@ struct mrq_clk_response { ...@@ -1050,13 +1092,16 @@ struct mrq_clk_response {
struct cmd_clk_is_enabled_response clk_is_enabled; struct cmd_clk_is_enabled_response clk_is_enabled;
struct cmd_clk_get_all_info_response clk_get_all_info; struct cmd_clk_get_all_info_response clk_get_all_info;
struct cmd_clk_get_max_clk_id_response clk_get_max_clk_id; struct cmd_clk_get_max_clk_id_response clk_get_max_clk_id;
struct cmd_clk_get_fmax_at_vmin_response clk_get_fmax_at_vmin;
} __UNION_ANON; } __UNION_ANON;
} __ABI_PACKED; } __ABI_PACKED;
/** @} */
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_QUERY_ABI * @def MRQ_QUERY_ABI
* @brief check if an MRQ is implemented * @brief Check if an MRQ is implemented
* *
* * Platforms: All * * Platforms: All
* * Initiators: Any * * Initiators: Any
...@@ -1067,7 +1112,7 @@ struct mrq_clk_response { ...@@ -1067,7 +1112,7 @@ struct mrq_clk_response {
/** /**
* @ingroup ABI_info * @ingroup ABI_info
* @brief request with MRQ_QUERY_ABI * @brief Request with MRQ_QUERY_ABI
* *
* Used by #MRQ_QUERY_ABI call to check if MRQ code #mrq is supported * Used by #MRQ_QUERY_ABI call to check if MRQ code #mrq is supported
* by the recipient. * by the recipient.
...@@ -1079,7 +1124,7 @@ struct mrq_query_abi_request { ...@@ -1079,7 +1124,7 @@ struct mrq_query_abi_request {
/** /**
* @ingroup ABI_info * @ingroup ABI_info
* @brief response to MRQ_QUERY_ABI * @brief Response to MRQ_QUERY_ABI
* *
* @note mrq_response::err of 0 indicates that the query was * @note mrq_response::err of 0 indicates that the query was
* successful, not that the MRQ itself is supported! * successful, not that the MRQ itself is supported!
...@@ -1092,19 +1137,19 @@ struct mrq_query_abi_response { ...@@ -1092,19 +1137,19 @@ struct mrq_query_abi_response {
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_PG_READ_STATE * @def MRQ_PG_READ_STATE
* @brief read the power-gating state of a partition * @brief Read the power-gating state of a partition
* *
* * Platforms: T186 * * Platforms: T186
* @cond bpmp_t186
* * Initiators: Any * * Initiators: Any
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_pg_read_state_request * * Request Payload: @ref mrq_pg_read_state_request
* * Response Payload: @ref mrq_pg_read_state_response * * Response Payload: @ref mrq_pg_read_state_response
* @addtogroup Powergating
* @{
*/ */
/** /**
* @brief request with #MRQ_PG_READ_STATE * @ingroup Powergating
* @brief Request with #MRQ_PG_READ_STATE
* *
* Used by MRQ_PG_READ_STATE call to read the current state of a * Used by MRQ_PG_READ_STATE call to read the current state of a
* partition. * partition.
...@@ -1115,39 +1160,40 @@ struct mrq_pg_read_state_request { ...@@ -1115,39 +1160,40 @@ struct mrq_pg_read_state_request {
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @brief response to MRQ_PG_READ_STATE * @ingroup Powergating
* @brief Response to MRQ_PG_READ_STATE
* @todo define possible errors. * @todo define possible errors.
*/ */
struct mrq_pg_read_state_response { struct mrq_pg_read_state_response {
/** @brief read as don't care */ /** @brief Read as don't care */
uint32_t sram_state; uint32_t sram_state;
/** @brief state of power partition /** @brief State of power partition
* * 0 : off * * 0 : off
* * 1 : on * * 1 : on
*/ */
uint32_t logic_state; uint32_t logic_state;
} __ABI_PACKED; } __ABI_PACKED;
/** @endcond*/
/** @} */ /** @} */
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_PG_UPDATE_STATE * @def MRQ_PG_UPDATE_STATE
* @brief modify the power-gating state of a partition. In contrast to * @brief Modify the power-gating state of a partition. In contrast to
* MRQ_PG calls, the operations that change state (on/off) of power * MRQ_PG calls, the operations that change state (on/off) of power
* partition are reference counted. * partition are reference counted.
* *
* * Platforms: T186 * * Platforms: T186
* @cond bpmp_t186
* * Initiators: Any * * Initiators: Any
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_pg_update_state_request * * Request Payload: @ref mrq_pg_update_state_request
* * Response Payload: N/A * * Response Payload: N/A
* @addtogroup Powergating
* @{
*/ */
/** /**
* @brief request with mrq_pg_update_state_request * @ingroup Powergating
* @brief Request with mrq_pg_update_state_request
* *
* Used by #MRQ_PG_UPDATE_STATE call to request BPMP to change the * Used by #MRQ_PG_UPDATE_STATE call to request BPMP to change the
* state of a power partition #partition_id. * state of a power partition #partition_id.
...@@ -1155,20 +1201,20 @@ struct mrq_pg_read_state_response { ...@@ -1155,20 +1201,20 @@ struct mrq_pg_read_state_response {
struct mrq_pg_update_state_request { struct mrq_pg_update_state_request {
/** @brief ID of partition */ /** @brief ID of partition */
uint32_t partition_id; uint32_t partition_id;
/** @brief secondary control of power partition /** @brief Secondary control of power partition
* @details Ignored by many versions of the BPMP * @details Ignored by many versions of the BPMP
* firmware. For maximum compatibility, set the value * firmware. For maximum compatibility, set the value
* according to @logic_state * according to @ref logic_state
* * 0x1: power ON partition (@ref logic_state == 0x3) * * 0x1: power ON partition (@ref logic_state == 0x3)
* * 0x3: power OFF partition (@ref logic_state == 0x1) * * 0x3: power OFF partition (@ref logic_state == 0x1)
*/ */
uint32_t sram_state; uint32_t sram_state;
/** @brief controls state of power partition, legal values are /** @brief Controls state of power partition, legal values are
* * 0x1 : power OFF partition * * 0x1 : power OFF partition
* * 0x3 : power ON partition * * 0x3 : power ON partition
*/ */
uint32_t logic_state; uint32_t logic_state;
/** @brief change state of clocks of the power partition, legal values /** @brief Change state of clocks of the power partition, legal values
* * 0x0 : do not change clock state * * 0x0 : do not change clock state
* * 0x1 : disable partition clocks (only applicable when * * 0x1 : disable partition clocks (only applicable when
* @ref logic_state == 0x1) * @ref logic_state == 0x1)
...@@ -1177,7 +1223,7 @@ struct mrq_pg_update_state_request { ...@@ -1177,7 +1223,7 @@ struct mrq_pg_update_state_request {
*/ */
uint32_t clock_state; uint32_t clock_state;
} __ABI_PACKED; } __ABI_PACKED;
/** @} */ /** @endcond*/
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
...@@ -1186,19 +1232,20 @@ struct mrq_pg_update_state_request { ...@@ -1186,19 +1232,20 @@ struct mrq_pg_update_state_request {
* MRQ_PG_UPDATE_STATE, operations that change the power partition * MRQ_PG_UPDATE_STATE, operations that change the power partition
* state are NOT reference counted * state are NOT reference counted
* *
* * Platforms: T186 * @note BPMP-FW forcefully turns off some partitions as part of SC7 entry
* because their state cannot be adequately restored on exit. Therefore,
* it is recommended to power off all domains via MRQ_PG prior to SC7 entry.
* See @ref bpmp_pdomain_ids for further detail.
*
* * Platforms: T186, T194
* * Initiators: Any * * Initiators: Any
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_pg_request * * Request Payload: @ref mrq_pg_request
* * Response Payload: @ref mrq_pg_response * * Response Payload: @ref mrq_pg_response
*
* @addtogroup Powergating * @addtogroup Powergating
* @{ * @{
*/ */
/**
* @name MRQ_PG sub-commands
* @{
*/
enum mrq_pg_cmd { enum mrq_pg_cmd {
/** /**
* @brief Check whether the BPMP driver supports the specified * @brief Check whether the BPMP driver supports the specified
...@@ -1232,7 +1279,7 @@ enum mrq_pg_cmd { ...@@ -1232,7 +1279,7 @@ enum mrq_pg_cmd {
CMD_PG_GET_STATE = 2, CMD_PG_GET_STATE = 2,
/** /**
* @brief get the name string of specified power domain id. * @brief Get the name string of specified power domain id.
* *
* mrq_response:err is * mrq_response:err is
* 0: Success * 0: Success
...@@ -1242,7 +1289,7 @@ enum mrq_pg_cmd { ...@@ -1242,7 +1289,7 @@ enum mrq_pg_cmd {
/** /**
* @brief get the highest power domain id in the system. Not * @brief Get the highest power domain id in the system. Not
* all IDs between 0 and max_id are valid IDs. * all IDs between 0 and max_id are valid IDs.
* *
* mrq_response:err is * mrq_response:err is
...@@ -1251,35 +1298,36 @@ enum mrq_pg_cmd { ...@@ -1251,35 +1298,36 @@ enum mrq_pg_cmd {
*/ */
CMD_PG_GET_MAX_ID = 4, CMD_PG_GET_MAX_ID = 4,
}; };
/** @} */
#define MRQ_PG_NAME_MAXLEN 40 #define MRQ_PG_NAME_MAXLEN 40
/**
* @brief possible power domain states in
* cmd_pg_set_state_request:state and cmd_pg_get_state_response:state.
* PG_STATE_OFF: power domain is OFF
* PG_STATE_ON: power domain is ON
* PG_STATE_RUNNING: power domain is ON and made into directly usable
* state by turning on the clocks associated with
* the domain
*/
enum pg_states { enum pg_states {
/** @brief Power domain is OFF */
PG_STATE_OFF = 0, PG_STATE_OFF = 0,
/** @brief Power domain is ON */
PG_STATE_ON = 1, PG_STATE_ON = 1,
/**
* @brief a legacy state where power domain and the clock
* associated to the domain are ON.
* This state is only supported in T186, and the use of it is
* deprecated.
*/
PG_STATE_RUNNING = 2, PG_STATE_RUNNING = 2,
}; };
struct cmd_pg_query_abi_request { struct cmd_pg_query_abi_request {
uint32_t type; /* enum mrq_pg_cmd */ /** @ref mrq_pg_cmd */
uint32_t type;
} __ABI_PACKED; } __ABI_PACKED;
struct cmd_pg_set_state_request { struct cmd_pg_set_state_request {
uint32_t state; /* enum pg_states */ /** @ref pg_states */
uint32_t state;
} __ABI_PACKED; } __ABI_PACKED;
struct cmd_pg_get_state_response { struct cmd_pg_get_state_response {
uint32_t state; /* enum pg_states */ /** @ref pg_states */
uint32_t state;
} __ABI_PACKED; } __ABI_PACKED;
struct cmd_pg_get_name_response { struct cmd_pg_get_name_response {
...@@ -1291,8 +1339,7 @@ struct cmd_pg_get_max_id_response { ...@@ -1291,8 +1339,7 @@ struct cmd_pg_get_max_id_response {
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Powergating * @brief Request with #MRQ_PG
* @brief request with #MRQ_PG
* *
* Used by the sender of an #MRQ_PG message to control power * Used by the sender of an #MRQ_PG message to control power
* partitions. The pg_request is split into several sub-commands. Some * partitions. The pg_request is split into several sub-commands. Some
...@@ -1308,7 +1355,6 @@ struct cmd_pg_get_max_id_response { ...@@ -1308,7 +1355,6 @@ struct cmd_pg_get_max_id_response {
* |CMD_PG_GET_MAX_ID | - | * |CMD_PG_GET_MAX_ID | - |
* *
*/ */
struct mrq_pg_request { struct mrq_pg_request {
uint32_t cmd; uint32_t cmd;
uint32_t id; uint32_t id;
...@@ -1319,8 +1365,7 @@ struct mrq_pg_request { ...@@ -1319,8 +1365,7 @@ struct mrq_pg_request {
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @ingroup Powergating * @brief Response to MRQ_PG
* @brief response to MRQ_PG
* *
* Each sub-command supported by @ref mrq_pg_request may return * Each sub-command supported by @ref mrq_pg_request may return
* sub-command-specific data. Some do and some do not as indicated in * sub-command-specific data. Some do and some do not as indicated in
...@@ -1333,9 +1378,7 @@ struct mrq_pg_request { ...@@ -1333,9 +1378,7 @@ struct mrq_pg_request {
* |CMD_PG_GET_STATE | get_state | * |CMD_PG_GET_STATE | get_state |
* |CMD_PG_GET_NAME | get_name | * |CMD_PG_GET_NAME | get_name |
* |CMD_PG_GET_MAX_ID | get_max_id | * |CMD_PG_GET_MAX_ID | get_max_id |
*
*/ */
struct mrq_pg_response { struct mrq_pg_response {
union { union {
struct cmd_pg_get_state_response get_state; struct cmd_pg_get_state_response get_state;
...@@ -1344,12 +1387,14 @@ struct mrq_pg_response { ...@@ -1344,12 +1387,14 @@ struct mrq_pg_response {
} __UNION_ANON; } __UNION_ANON;
} __ABI_PACKED; } __ABI_PACKED;
/** @} */
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_THERMAL * @def MRQ_THERMAL
* @brief interact with BPMP thermal framework * @brief Interact with BPMP thermal framework
* *
* * Platforms: T186 * * Platforms: T186, T194
* * Initiators: Any * * Initiators: Any
* * Targets: Any * * Targets: Any
* * Request Payload: TODO * * Request Payload: TODO
...@@ -1562,17 +1607,18 @@ union mrq_thermal_bpmp_to_host_response { ...@@ -1562,17 +1607,18 @@ union mrq_thermal_bpmp_to_host_response {
* @brief Query CPU voltage hint data * @brief Query CPU voltage hint data
* *
* * Platforms: T186 * * Platforms: T186
* @cond bpmp_t186
* * Initiators: CCPLEX * * Initiators: CCPLEX
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_cpu_vhint_request * * Request Payload: @ref mrq_cpu_vhint_request
* * Response Payload: N/A * * Response Payload: N/A
* *
* @addtogroup Vhint CPU Voltage hint * @addtogroup Vhint
* @{ * @{
*/ */
/** /**
* @brief request with #MRQ_CPU_VHINT * @brief Request with #MRQ_CPU_VHINT
* *
* Used by #MRQ_CPU_VHINT call by CCPLEX to retrieve voltage hint data * Used by #MRQ_CPU_VHINT call by CCPLEX to retrieve voltage hint data
* from BPMP to memory space pointed by #addr. CCPLEX is responsible * from BPMP to memory space pointed by #addr. CCPLEX is responsible
...@@ -1581,16 +1627,16 @@ union mrq_thermal_bpmp_to_host_response { ...@@ -1581,16 +1627,16 @@ union mrq_thermal_bpmp_to_host_response {
*/ */
struct mrq_cpu_vhint_request { struct mrq_cpu_vhint_request {
/** @brief IOVA address for the #cpu_vhint_data */ /** @brief IOVA address for the #cpu_vhint_data */
uint32_t addr; /* struct cpu_vhint_data * */ uint32_t addr;
/** @brief ID of the cluster whose data is requested */ /** @brief ID of the cluster whose data is requested */
uint32_t cluster_id; /* enum cluster_id */ uint32_t cluster_id;
} __ABI_PACKED; } __ABI_PACKED;
/** /**
* @brief description of the CPU v/f relation * @brief Description of the CPU v/f relation
* *
* Used by #MRQ_CPU_VHINT call to carry data pointed by #addr of * Used by #MRQ_CPU_VHINT call to carry data pointed by
* struct mrq_cpu_vhint_request * #mrq_cpu_vhint_request::addr
*/ */
struct cpu_vhint_data { struct cpu_vhint_data {
uint32_t ref_clk_hz; /**< reference frequency in Hz */ uint32_t ref_clk_hz; /**< reference frequency in Hz */
...@@ -1612,7 +1658,7 @@ struct cpu_vhint_data { ...@@ -1612,7 +1658,7 @@ struct cpu_vhint_data {
/** reserved for future use */ /** reserved for future use */
uint16_t reserved[328]; uint16_t reserved[328];
} __ABI_PACKED; } __ABI_PACKED;
/** @endcond */
/** @} */ /** @} */
/** /**
...@@ -1620,7 +1666,7 @@ struct cpu_vhint_data { ...@@ -1620,7 +1666,7 @@ struct cpu_vhint_data {
* @def MRQ_ABI_RATCHET * @def MRQ_ABI_RATCHET
* @brief ABI ratchet value query * @brief ABI ratchet value query
* *
* * Platforms: T186 * * Platforms: T186, T194
* * Initiators: Any * * Initiators: Any
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: @ref mrq_abi_ratchet_request * * Request Payload: @ref mrq_abi_ratchet_request
...@@ -1630,7 +1676,7 @@ struct cpu_vhint_data { ...@@ -1630,7 +1676,7 @@ struct cpu_vhint_data {
*/ */
/** /**
* @brief an ABI compatibility mechanism * @brief An ABI compatibility mechanism
* *
* BPMP_ABI_RATCHET_VALUE may increase for various reasons in a future * BPMP_ABI_RATCHET_VALUE may increase for various reasons in a future
* revision of this header file. * revision of this header file.
...@@ -1644,7 +1690,7 @@ struct cpu_vhint_data { ...@@ -1644,7 +1690,7 @@ struct cpu_vhint_data {
#define BPMP_ABI_RATCHET_VALUE 3 #define BPMP_ABI_RATCHET_VALUE 3
/** /**
* @brief request with #MRQ_ABI_RATCHET. * @brief Request with #MRQ_ABI_RATCHET.
* *
* #ratchet should be #BPMP_ABI_RATCHET_VALUE from the ABI header * #ratchet should be #BPMP_ABI_RATCHET_VALUE from the ABI header
* against which the requester was compiled. * against which the requester was compiled.
...@@ -1657,12 +1703,12 @@ struct cpu_vhint_data { ...@@ -1657,12 +1703,12 @@ struct cpu_vhint_data {
* Otherwise, err shall be 0. * Otherwise, err shall be 0.
*/ */
struct mrq_abi_ratchet_request { struct mrq_abi_ratchet_request {
/** @brief requester's ratchet value */ /** @brief Requester's ratchet value */
uint16_t ratchet; uint16_t ratchet;
}; };
/** /**
* @brief response to #MRQ_ABI_RATCHET * @brief Response to #MRQ_ABI_RATCHET
* *
* #ratchet shall be #BPMP_ABI_RATCHET_VALUE from the ABI header * #ratchet shall be #BPMP_ABI_RATCHET_VALUE from the ABI header
* against which BPMP firwmare was compiled. * against which BPMP firwmare was compiled.
...@@ -1685,9 +1731,9 @@ struct mrq_abi_ratchet_response { ...@@ -1685,9 +1731,9 @@ struct mrq_abi_ratchet_response {
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_EMC_DVFS_LATENCY * @def MRQ_EMC_DVFS_LATENCY
* @brief query frequency dependent EMC DVFS latency * @brief Query frequency dependent EMC DVFS latency
* *
* * Platforms: T186 * * Platforms: T186, T194
* * Initiators: CCPLEX * * Initiators: CCPLEX
* * Targets: BPMP * * Targets: BPMP
* * Request Payload: N/A * * Request Payload: N/A
...@@ -1697,7 +1743,7 @@ struct mrq_abi_ratchet_response { ...@@ -1697,7 +1743,7 @@ struct mrq_abi_ratchet_response {
*/ */
/** /**
* @brief used by @ref mrq_emc_dvfs_latency_response * @brief Used by @ref mrq_emc_dvfs_latency_response
*/ */
struct emc_dvfs_latency { struct emc_dvfs_latency {
/** @brief EMC frequency in kHz */ /** @brief EMC frequency in kHz */
...@@ -1708,10 +1754,10 @@ struct emc_dvfs_latency { ...@@ -1708,10 +1754,10 @@ struct emc_dvfs_latency {
#define EMC_DVFS_LATENCY_MAX_SIZE 14 #define EMC_DVFS_LATENCY_MAX_SIZE 14
/** /**
* @brief response to #MRQ_EMC_DVFS_LATENCY * @brief Response to #MRQ_EMC_DVFS_LATENCY
*/ */
struct mrq_emc_dvfs_latency_response { struct mrq_emc_dvfs_latency_response {
/** @brief the number valid entries in #pairs */ /** @brief The number valid entries in #pairs */
uint32_t num_pairs; uint32_t num_pairs;
/** @brief EMC <frequency, latency> information */ /** @brief EMC <frequency, latency> information */
struct emc_dvfs_latency pairs[EMC_DVFS_LATENCY_MAX_SIZE]; struct emc_dvfs_latency pairs[EMC_DVFS_LATENCY_MAX_SIZE];
...@@ -1719,10 +1765,98 @@ struct mrq_emc_dvfs_latency_response { ...@@ -1719,10 +1765,98 @@ struct mrq_emc_dvfs_latency_response {
/** @} */ /** @} */
/**
* @ingroup MRQ_Codes
* @def MRQ_CPU_NDIV_LIMITS
* @brief CPU freq. limits in ndiv
*
* * Platforms: T194 onwards
* @cond bpmp_t194
* * Initiators: CCPLEX
* * Targets: BPMP
* * Request Payload: @ref mrq_cpu_ndiv_limits_request
* * Response Payload: @ref mrq_cpu_ndiv_limits_response
* @addtogroup CPU
* @{
*/
/**
* @brief Request for ndiv limits of a cluster
*/
struct mrq_cpu_ndiv_limits_request {
/** @brief Enum cluster_id */
uint32_t cluster_id;
} __ABI_PACKED;
/**
* @brief Response to #MRQ_CPU_NDIV_LIMITS
*/
struct mrq_cpu_ndiv_limits_response {
/** @brief Reference frequency in Hz */
uint32_t ref_clk_hz;
/** @brief Post divider value */
uint16_t pdiv;
/** @brief Input divider value */
uint16_t mdiv;
/** @brief FMAX expressed with max NDIV value */
uint16_t ndiv_max;
/** @brief Minimum allowed NDIV value */
uint16_t ndiv_min;
} __ABI_PACKED;
/** @} */
/** @endcond */
/**
* @ingroup MRQ_Codes
* @def MRQ_CPU_AUTO_CC3
* @brief Query CPU cluster auto-CC3 configuration
*
* * Platforms: T194 onwards
* @cond bpmp_t194
* * Initiators: CCPLEX
* * Targets: BPMP
* * Request Payload: @ref mrq_cpu_auto_cc3_request
* * Response Payload: @ref mrq_cpu_auto_cc3_response
* @addtogroup CC3
*
* Queries from BPMP auto-CC3 configuration (allowed/not allowed) for a
* specified cluster. CCPLEX s/w uses this information to override its own
* device tree auto-CC3 settings, so that BPMP device tree is a single source of
* auto-CC3 platform configuration.
*
* @{
*/
/**
* @brief Request for auto-CC3 configuration of a cluster
*/
struct mrq_cpu_auto_cc3_request {
/** @brief Enum cluster_id (logical cluster id, known to CCPLEX s/w) */
uint32_t cluster_id;
} __ABI_PACKED;
/**
* @brief Response to #MRQ_CPU_AUTO_CC3
*/
struct mrq_cpu_auto_cc3_response {
/**
* @brief auto-CC3 configuration
*
* - bits[31..10] reserved.
* - bits[9..1] cc3 ndiv
* - bit [0] if "1" auto-CC3 is allowed, if "0" auto-CC3 is not allowed
*/
uint32_t auto_cc3_config;
} __ABI_PACKED;
/** @} */
/** @endcond */
/** /**
* @ingroup MRQ_Codes * @ingroup MRQ_Codes
* @def MRQ_TRACE_ITER * @def MRQ_TRACE_ITER
* @brief manage the trace iterator * @brief Manage the trace iterator
* *
* * Platforms: All * * Platforms: All
* * Initiators: CCPLEX * * Initiators: CCPLEX
...@@ -1735,12 +1869,12 @@ struct mrq_emc_dvfs_latency_response { ...@@ -1735,12 +1869,12 @@ struct mrq_emc_dvfs_latency_response {
enum { enum {
/** @brief (re)start the tracing now. Ignore older events */ /** @brief (re)start the tracing now. Ignore older events */
TRACE_ITER_INIT = 0, TRACE_ITER_INIT = 0,
/** @brief clobber all events in the trace buffer */ /** @brief Clobber all events in the trace buffer */
TRACE_ITER_CLEAN = 1 TRACE_ITER_CLEAN = 1
}; };
/** /**
* @brief request with #MRQ_TRACE_ITER * @brief Request with #MRQ_TRACE_ITER
*/ */
struct mrq_trace_iter_request { struct mrq_trace_iter_request {
/** @brief TRACE_ITER_INIT or TRACE_ITER_CLEAN */ /** @brief TRACE_ITER_INIT or TRACE_ITER_CLEAN */
...@@ -1900,7 +2034,7 @@ struct cmd_ringbuf_console_get_fifo_resp { ...@@ -1900,7 +2034,7 @@ struct cmd_ringbuf_console_get_fifo_resp {
*/ */
struct mrq_ringbuf_console_host_to_bpmp_request { struct mrq_ringbuf_console_host_to_bpmp_request {
/** /**
* @brief type of request. Values listed in enum * @brief Type of request. Values listed in enum
* #mrq_ringbuf_console_host_to_bpmp_cmd. * #mrq_ringbuf_console_host_to_bpmp_cmd.
*/ */
uint32_t type; uint32_t type;
...@@ -1927,49 +2061,616 @@ union mrq_ringbuf_console_bpmp_to_host_response { ...@@ -1927,49 +2061,616 @@ union mrq_ringbuf_console_bpmp_to_host_response {
} __ABI_PACKED; } __ABI_PACKED;
/** @} */ /** @} */
/* /**
* 4. Enumerations * @ingroup MRQ_Codes
* @def MRQ_STRAP
* @brief Set a strap value controlled by BPMP
*
* * Platforms: T194 onwards
* @cond bpmp_t194
* * Initiators: CCPLEX
* * Targets: BPMP
* * Request Payload: @ref mrq_strap_request
* * Response Payload: N/A
* @addtogroup Strap
*
* A strap is an input that is sampled by a hardware unit during the
* unit's startup process. The sampled value of a strap affects the
* behavior of the unit until the unit is restarted. Many hardware
* units sample their straps at the instant that their resets are
* deasserted.
*
* BPMP owns registers which act as straps to various units. It
* exposes limited control of those straps via #MRQ_STRAP.
*
* @{
*/ */
enum mrq_strap_cmd {
/** @private */
STRAP_RESERVED = 0,
/** @brief Set a strap value */
STRAP_SET = 1
};
/* /**
* 4.1 CPU enumerations * @brief Request with #MRQ_STRAP
*/
struct mrq_strap_request {
/** @brief @ref mrq_strap_cmd */
uint32_t cmd;
/** @brief Strap ID from @ref Strap_Ids */
uint32_t id;
/** @brief Desired value for strap (if cmd is #STRAP_SET) */
uint32_t value;
} __ABI_PACKED;
/**
* @defgroup Strap_Ids Strap Identifiers
* @}
*/
/** @endcond */
/**
* @ingroup MRQ_Codes
* @def MRQ_UPHY
* @brief Perform a UPHY operation
* *
* See <mach-t186/system-t186.h> * * Platforms: T194 onwards
* @cond bpmp_t194
* * Initiators: CCPLEX
* * Targets: BPMP
* * Request Payload: @ref mrq_uphy_request
* * Response Payload: @ref mrq_uphy_response
* *
* 4.2 CPU Cluster enumerations * @addtogroup UPHY
* @{
*/
enum {
CMD_UPHY_PCIE_LANE_MARGIN_CONTROL = 1,
CMD_UPHY_PCIE_LANE_MARGIN_STATUS = 2,
CMD_UPHY_PCIE_EP_CONTROLLER_PLL_INIT = 3,
CMD_UPHY_PCIE_CONTROLLER_STATE = 4,
CMD_UPHY_MAX,
};
struct cmd_uphy_margin_control_request {
/** @brief Enable margin */
int32_t en;
/** @brief Clear the number of error and sections */
int32_t clr;
/** @brief Set x offset (1's complement) for left/right margin type (y should be 0) */
uint32_t x;
/** @brief Set y offset (1's complement) for left/right margin type (x should be 0) */
uint32_t y;
/** @brief Set number of bit blocks for each margin section */
uint32_t nblks;
} __ABI_PACKED;
struct cmd_uphy_margin_status_response {
/** @brief Number of errors observed */
uint32_t status;
} __ABI_PACKED;
struct cmd_uphy_ep_controller_pll_init_request {
/** @brief EP controller number, valid: 0, 4, 5 */
uint8_t ep_controller;
} __ABI_PACKED;
struct cmd_uphy_pcie_controller_state_request {
/** @brief PCIE controller number, valid: 0, 1, 2, 3, 4 */
uint8_t pcie_controller;
uint8_t enable;
} __ABI_PACKED;
/**
* @ingroup UPHY
* @brief Request with #MRQ_UPHY
* *
* See <mach-t186/system-t186.h> * Used by the sender of an #MRQ_UPHY message to control UPHY Lane RX margining.
* The uphy_request is split into several sub-commands. Some sub-commands
* require no additional data. Others have a sub-command specific payload
* *
* 4.3 System low power state enumerations * |sub-command |payload |
* |------------------------------------ |----------------------------------------|
* |CMD_UPHY_PCIE_LANE_MARGIN_CONTROL |uphy_set_margin_control |
* |CMD_UPHY_PCIE_LANE_MARGIN_STATUS | |
* |CMD_UPHY_PCIE_EP_CONTROLLER_PLL_INIT |cmd_uphy_ep_controller_pll_init_request |
* |CMD_UPHY_PCIE_CONTROLLER_STATE |cmd_uphy_pcie_controller_state_request |
* *
* See <mach-t186/system-t186.h>
*/ */
/* struct mrq_uphy_request {
* 4.4 Clock enumerations /** @brief Lane number. */
uint16_t lane;
/** @brief Sub-command id. */
uint16_t cmd;
union {
struct cmd_uphy_margin_control_request uphy_set_margin_control;
struct cmd_uphy_ep_controller_pll_init_request ep_ctrlr_pll_init;
struct cmd_uphy_pcie_controller_state_request controller_state;
} __UNION_ANON;
} __ABI_PACKED;
/**
* @ingroup UPHY
* @brief Response to MRQ_UPHY
*
* Each sub-command supported by @ref mrq_uphy_request may return
* sub-command-specific data. Some do and some do not as indicated in
* the following table
*
* |sub-command |payload |
* |---------------------------- |------------------------|
* |CMD_UPHY_PCIE_LANE_MARGIN_CONTROL | |
* |CMD_UPHY_PCIE_LANE_MARGIN_STATUS |uphy_get_margin_status |
* *
* For clock enumerations, see <mach-t186/clk-t186.h>
*/ */
/* struct mrq_uphy_response {
* 4.5 Reset enumerations union {
struct cmd_uphy_margin_status_response uphy_get_margin_status;
} __UNION_ANON;
} __ABI_PACKED;
/** @} */
/** @endcond */
/**
* @ingroup MRQ_Codes
* @def MRQ_FMON
* @brief Perform a frequency monitor configuration operations
*
* * Platforms: T194 onwards
* @cond bpmp_t194
* * Initiators: CCPLEX
* * Targets: BPMP
* * Request Payload: @ref mrq_fmon_request
* * Response Payload: @ref mrq_fmon_response
* *
* For reset enumerations, see <mach-t186/reset-t186.h> * @addtogroup FMON
* @{
*/ */
enum {
/**
* @brief Clamp FMON configuration to specified rate.
*
* The monitored clock must be running for clamp to succeed. If
* clamped, FMON configuration is preserved when clock rate
* and/or state is changed.
*/
CMD_FMON_GEAR_CLAMP = 1,
/**
* @brief Release clamped FMON configuration.
*
* Allow FMON configuration to follow monitored clock rate
* and/or state changes.
*/
CMD_FMON_GEAR_FREE = 2,
/**
* @brief Return rate FMON is clamped at, or 0 if FMON is not
* clamped.
*
* Inherently racy, since clamp state can be changed
* concurrently. Useful for testing.
*/
CMD_FMON_GEAR_GET = 3,
CMD_FMON_NUM,
};
/* struct cmd_fmon_gear_clamp_request {
* 4.6 Thermal sensor enumerations int32_t unused;
int64_t rate;
} __ABI_PACKED;
/** @private */
struct cmd_fmon_gear_clamp_response {
EMPTY
} __ABI_PACKED;
/** @private */
struct cmd_fmon_gear_free_request {
EMPTY
} __ABI_PACKED;
/** @private */
struct cmd_fmon_gear_free_response {
EMPTY
} __ABI_PACKED;
/** @private */
struct cmd_fmon_gear_get_request {
EMPTY
} __ABI_PACKED;
struct cmd_fmon_gear_get_response {
int64_t rate;
} __ABI_PACKED;
/**
* @ingroup FMON
* @brief Request with #MRQ_FMON
*
* Used by the sender of an #MRQ_FMON message to configure clock
* frequency monitors. The FMON request is split into several
* sub-commands. Some sub-commands require no additional data.
* Others have a sub-command specific payload
*
* |sub-command |payload |
* |----------------------------|-----------------------|
* |CMD_FMON_GEAR_CLAMP |fmon_gear_clamp |
* |CMD_FMON_GEAR_FREE |- |
* |CMD_FMON_GEAR_GET |- |
*
*/
struct mrq_fmon_request {
/** @brief Sub-command and clock id concatenated to 32-bit word.
* - bits[31..24] is the sub-cmd.
* - bits[23..0] is monitored clock id used to select target
* FMON
*/
uint32_t cmd_and_id;
union {
struct cmd_fmon_gear_clamp_request fmon_gear_clamp;
/** @private */
struct cmd_fmon_gear_free_request fmon_gear_free;
/** @private */
struct cmd_fmon_gear_get_request fmon_gear_get;
} __UNION_ANON;
} __ABI_PACKED;
/**
* @ingroup FMON
* @brief Response to MRQ_FMON
*
* Each sub-command supported by @ref mrq_fmon_request may
* return sub-command-specific data as indicated below.
*
* |sub-command |payload |
* |----------------------------|------------------------|
* |CMD_FMON_GEAR_CLAMP |- |
* |CMD_FMON_GEAR_FREE |- |
* |CMD_FMON_GEAR_GET |fmon_gear_get |
*
*/
struct mrq_fmon_response {
union {
/** @private */
struct cmd_fmon_gear_clamp_response fmon_gear_clamp;
/** @private */
struct cmd_fmon_gear_free_response fmon_gear_free;
struct cmd_fmon_gear_get_response fmon_gear_get;
} __UNION_ANON;
} __ABI_PACKED;
/** @} */
/** @endcond */
/**
* @ingroup MRQ_Codes
* @def MRQ_EC
* @brief Provide status information on faults reported by Error
* Collator (EC) to HSM.
*
* * Platforms: T194 onwards
* @cond bpmp_t194
* * Initiators: CCPLEX
* * Targets: BPMP
* * Request Payload: @ref mrq_ec_request
* * Response Payload: @ref mrq_ec_response
*
* @note This MRQ ABI is under construction, and subject to change
*
* @addtogroup EC
* @{
*/
enum {
/**
* @brief Retrieve specified EC status.
*
* mrq_response::err is 0 if the operation was successful, or @n
* -#BPMP_ENODEV if target EC is not owned by BPMP @n
* -#BPMP_EACCES if target EC power domain is turned off
*/
CMD_EC_STATUS_GET = 1,
CMD_EC_NUM,
};
/** @brief BPMP ECs error types */
enum bpmp_ec_err_type {
/** @brief Parity error on internal data path
*
* Error descriptor @ref ec_err_simple_desc.
*/
EC_ERR_TYPE_PARITY_INTERNAL = 1,
/** @brief ECC SEC error on internal data path
*
* Error descriptor @ref ec_err_simple_desc.
*/
EC_ERR_TYPE_ECC_SEC_INTERNAL = 2,
/** @brief ECC DED error on internal data path
*
* Error descriptor @ref ec_err_simple_desc.
*/
EC_ERR_TYPE_ECC_DED_INTERNAL = 3,
/** @brief Comparator error
*
* Error descriptor @ref ec_err_simple_desc.
*/
EC_ERR_TYPE_COMPARATOR = 4,
/** @brief Register parity error
*
* Error descriptor @ref ec_err_reg_parity_desc.
*/
EC_ERR_TYPE_REGISTER_PARITY = 5,
/** @brief Parity error from on-chip SRAM/FIFO
*
* Error descriptor @ref ec_err_simple_desc.
*/
EC_ERR_TYPE_PARITY_SRAM = 6,
/** @brief Clock Monitor error
*
* Error descriptor @ref ec_err_fmon_desc.
*/
EC_ERR_TYPE_CLOCK_MONITOR = 9,
/** @brief Voltage Monitor error
*
* Error descriptor @ref ec_err_vmon_desc.
*/
EC_ERR_TYPE_VOLTAGE_MONITOR = 10,
/** @brief SW Correctable error
*
* Error descriptor @ref ec_err_simple_desc.
*/
EC_ERR_TYPE_SW_CORRECTABLE = 16,
/** @brief SW Uncorrectable error
*
* Error descriptor @ref ec_err_simple_desc.
*/
EC_ERR_TYPE_SW_UNCORRECTABLE = 17,
/** @brief Other HW Correctable error
*
* Error descriptor @ref ec_err_simple_desc.
*/
EC_ERR_TYPE_OTHER_HW_CORRECTABLE = 32,
/** @brief Other HW Uncorrectable error
*
* Error descriptor @ref ec_err_simple_desc.
*/
EC_ERR_TYPE_OTHER_HW_UNCORRECTABLE = 33,
};
/** @brief Group of registers with parity error. */
enum ec_registers_group {
/** @brief Functional registers group */
EC_ERR_GROUP_FUNC_REG = 0,
/** @brief SCR registers group */
EC_ERR_GROUP_SCR_REG = 1,
};
/**
* @defgroup bpmp_ec_status_flags EC Status Flags
* @addtogroup bpmp_ec_status_flags
* @{
*/
/** @brief No EC error found flag */
#define EC_STATUS_FLAG_NO_ERROR 0x0001
/** @brief Last EC error found flag */
#define EC_STATUS_FLAG_LAST_ERROR 0x0002
/** @brief EC latent error flag */
#define EC_STATUS_FLAG_LATENT_ERROR 0x0004
/** @} */
/**
* @defgroup bpmp_ec_desc_flags EC Descriptor Flags
* @addtogroup bpmp_ec_desc_flags
* @{
*/
/** @brief EC descriptor error resolved flag */
#define EC_DESC_FLAG_RESOLVED 0x0001
/** @brief EC descriptor failed to retrieve id flag */
#define EC_DESC_FLAG_NO_ID 0x0002
/** @} */
/**
* |error type | fmon_clk_id values |
* |---------------------------------|---------------------------|
* |@ref EC_ERR_TYPE_CLOCK_MONITOR |@ref bpmp_clock_ids |
*/
struct ec_err_fmon_desc {
/** @brief Bitmask of @ref bpmp_ec_desc_flags */
uint16_t desc_flags;
/** @brief FMON monitored clock id */
uint16_t fmon_clk_id;
/** @brief Bitmask of @ref bpmp_fmon_faults_flags */
uint32_t fmon_faults;
/** @brief FMON faults access error */
int32_t fmon_access_error;
} __ABI_PACKED;
/**
* |error type | vmon_adc_id values |
* |---------------------------------|---------------------------|
* |@ref EC_ERR_TYPE_VOLTAGE_MONITOR |@ref bpmp_adc_ids |
*/
struct ec_err_vmon_desc {
/** @brief Bitmask of @ref bpmp_ec_desc_flags */
uint16_t desc_flags;
/** @brief VMON rail adc id */
uint16_t vmon_adc_id;
/** @brief Bitmask of @ref bpmp_vmon_faults_flags */
uint32_t vmon_faults;
/** @brief VMON faults access error */
int32_t vmon_access_error;
} __ABI_PACKED;
/**
* |error type | reg_id values |
* |---------------------------------|---------------------------|
* |@ref EC_ERR_TYPE_REGISTER_PARITY |@ref bpmp_ec_registers_ids |
*/
struct ec_err_reg_parity_desc {
/** @brief Bitmask of @ref bpmp_ec_desc_flags */
uint16_t desc_flags;
/** @brief Register id */
uint16_t reg_id;
/** @brief Register group @ref ec_registers_group */
uint16_t reg_group;
} __ABI_PACKED;
/**
* |error type | err_source_id values |
* |----------------------------------------|---------------------------|
* |@ref EC_ERR_TYPE_PARITY_INTERNAL |@ref bpmp_ec_ipath_ids |
* |@ref EC_ERR_TYPE_ECC_SEC_INTERNAL |@ref bpmp_ec_ipath_ids |
* |@ref EC_ERR_TYPE_ECC_DED_INTERNAL |@ref bpmp_ec_ipath_ids |
* |@ref EC_ERR_TYPE_COMPARATOR |@ref bpmp_ec_comparator_ids|
* |@ref EC_ERR_TYPE_PARITY_SRAM |@ref bpmp_clock_ids |
* |@ref EC_ERR_TYPE_SW_CORRECTABLE |@ref bpmp_ec_misc_ids |
* |@ref EC_ERR_TYPE_SW_UNCORRECTABLE |@ref bpmp_ec_misc_ids |
* |@ref EC_ERR_TYPE_OTHER_HW_CORRECTABLE |@ref bpmp_ec_misc_ids |
* |@ref EC_ERR_TYPE_OTHER_HW_UNCORRECTABLE |@ref bpmp_ec_misc_ids |
*/
struct ec_err_simple_desc {
/** @brief Bitmask of @ref bpmp_ec_desc_flags */
uint16_t desc_flags;
/** @brief Error source id. Id space depends on error type. */
uint16_t err_source_id;
} __ABI_PACKED;
/** @brief Union of EC error descriptors */
union ec_err_desc {
struct ec_err_fmon_desc fmon_desc;
struct ec_err_vmon_desc vmon_desc;
struct ec_err_reg_parity_desc reg_parity_desc;
struct ec_err_simple_desc simple_desc;
} __ABI_PACKED;
struct cmd_ec_status_get_request {
/** @brief HSM error line number that identifies target EC. */
uint32_t ec_hsm_id;
} __ABI_PACKED;
/** EC status maximum number of descriptors */
#define EC_ERR_STATUS_DESC_MAX_NUM 4
struct cmd_ec_status_get_response {
/** @brief Target EC id (the same id received with request). */
uint32_t ec_hsm_id;
/**
* @brief Bitmask of @ref bpmp_ec_status_flags
*
* If NO_ERROR flag is set, error_ fields should be ignored
*/
uint32_t ec_status_flags;
/** @brief Found EC error index. */
uint32_t error_idx;
/** @brief Found EC error type @ref bpmp_ec_err_type. */
uint32_t error_type;
/** @brief Number of returned EC error descriptors */
uint32_t error_desc_num;
/** @brief EC error descriptors */
union ec_err_desc error_descs[EC_ERR_STATUS_DESC_MAX_NUM];
} __ABI_PACKED;
/**
* @ingroup EC
* @brief Request with #MRQ_EC
*
* Used by the sender of an #MRQ_EC message to access ECs owned
* by BPMP.
*
* |sub-command |payload |
* |----------------------------|-----------------------|
* |@ref CMD_EC_STATUS_GET |ec_status_get |
* *
* For thermal sensor enumerations, see <mach-t186/thermal-t186.h>
*/ */
struct mrq_ec_request {
/** @brief Sub-command id. */
uint32_t cmd_id;
union {
struct cmd_ec_status_get_request ec_status_get;
} __UNION_ANON;
} __ABI_PACKED;
/** /**
* @defgroup Error_Codes * @ingroup EC
* @brief Response to MRQ_EC
*
* Each sub-command supported by @ref mrq_ec_request may return
* sub-command-specific data as indicated below.
*
* |sub-command |payload |
* |----------------------------|------------------------|
* |@ref CMD_EC_STATUS_GET |ec_status_get |
*
*/
struct mrq_ec_response {
union {
struct cmd_ec_status_get_response ec_status_get;
} __UNION_ANON;
} __ABI_PACKED;
/** @} */
/** @endcond */
/**
* @ingroup MRQ_Codes
* @def MRQ_FBVOLT_STATUS
* @brief Provides status information about voltage state for fuse burning
*
* * Platforms: T194 onwards
* @cond bpmp_t194
* * Initiators: CCPLEX
* * Target: BPMP
* * Request Payload: None
* * Response Payload: @ref mrq_fbvolt_status_response
* @{
*/
/**
* @ingroup Fbvolt_status
* @brief Response to #MRQ_FBVOLT_STATUS
*
* Value of #ready reflects if core voltages are in a suitable state for buring
* fuses. A value of 0x1 indicates that core voltages are ready for burning
* fuses. A value of 0x0 indicates that core voltages are not ready.
*/
struct mrq_fbvolt_status_response {
/** @brief Bit [0:0] - ready status, bits [31:1] - reserved */
uint32_t ready;
/** @brief Reserved */
uint32_t unused;
} __ABI_PACKED;
/** @} */
/** @endcond */
/**
* @addtogroup Error_Codes
* Negative values for mrq_response::err generally indicate some * Negative values for mrq_response::err generally indicate some
* error. The ABI defines the following error codes. Negating these * error. The ABI defines the following error codes. Negating these
* defines is an exercise left to the user. * defines is an exercise left to the user.
* @{ * @{
*/ */
/** @brief No such file or directory */ /** @brief No such file or directory */
#define BPMP_ENOENT 2 #define BPMP_ENOENT 2
/** @brief No MRQ handler */ /** @brief No MRQ handler */
...@@ -1994,6 +2695,11 @@ union mrq_ringbuf_console_bpmp_to_host_response { ...@@ -1994,6 +2695,11 @@ union mrq_ringbuf_console_bpmp_to_host_response {
#define BPMP_ETIMEDOUT 23 #define BPMP_ETIMEDOUT 23
/** @brief Out of range */ /** @brief Out of range */
#define BPMP_ERANGE 34 #define BPMP_ERANGE 34
/** @brief Function not implemented */
#define BPMP_ENOSYS 38
/** @brief Invalid slot */
#define BPMP_EBADSLT 57
/** @} */ /** @} */
/** @} */
#endif #endif
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7