tisci_protocol.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2017-2022 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
#ifndef TISCI_PROTOCOL_H
#define TISCI_PROTOCOL_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
 
#define TISCI_MSG_FLAG_RESERVED0    TISCI_BIT(0)
 
#define TISCI_MSG_FLAG_AOP    TISCI_BIT(1)
 
#define TISCI_MSG_FLAG_SEC    TISCI_BIT(2)
 
#define TISCI_MSG_FLAG_ACK    TISCI_BIT(1)
 
struct tisci_header {
    uint16_t    type;
    uint8_t    host;
    uint8_t    seq;
    uint32_t    flags;
    /* Windows Visual Studio build has issues with  payload[], changing it only for visual studio build */ 
#ifdef _MSC_VER 
    uint8_t    payload; 
#else 
    uint8_t    payload[]; 
#endif
};
 
/*
 * Messages sent via secure transport need an additional field for integrity
 * check in addition to the fields of a TISCI message. The below data structure
 * is used to enhance the standard TISCI message header with a field for
 * integrity check and a reserved field for future use.
 *
 * The below defined header is placed before the \ref tisci_header when
 * transmitting a message via a secure transport.
 *
 * For more information, please refer to the TISCI documentation.
 */
 
struct tisci_sec_header {
    uint16_t    integ_check;
    uint16_t    rsvd;
};
 
/* TISCI Message IDs */
#define TISCI_MSG_VERSION                       (0x0002U)
#define TISCI_MSG_BOOT_NOTIFICATION             (0x000AU)
#define TISCI_MSG_BOARD_CONFIG                  (0x000BU)
#define TISCI_MSG_BOARD_CONFIG_RM               (0x000CU)
#define TISCI_MSG_BOARD_CONFIG_SECURITY         (0x000DU)
#define TISCI_MSG_BOARD_CONFIG_PM               (0x000EU)
 
#define TISCI_MSG_ENABLE_WDT                    (0x0000U)
#define TISCI_MSG_WAKE_RESET                    (0x0001U)
#define TISCI_MSG_WAKE_REASON                   (0x0003U)
#define TISCI_MSG_GOODBYE                       (0x0004U)
#define TISCI_MSG_SYS_RESET                     (0x0005U)
 
#define TISCI_MSG_QUERY_MSMC                    (0x0020U)
#define TISCI_MSG_GET_TRACE_CONFIG              (0x0021U)
#define TISCI_MSG_QUERY_FW_CAPS                 (0x0022U)
 
#define TISCI_MSG_SET_CLOCK                     (0x0100U)
#define TISCI_MSG_GET_CLOCK                     (0x0101U)
#define TISCI_MSG_SET_CLOCK_PARENT              (0x0102U)
#define TISCI_MSG_GET_CLOCK_PARENT              (0x0103U)
#define TISCI_MSG_GET_NUM_CLOCK_PARENTS         (0x0104U)
#define TISCI_MSG_SET_FREQ                      (0x010cU)
#define TISCI_MSG_QUERY_FREQ                    (0x010dU)
#define TISCI_MSG_GET_FREQ                      (0x010eU)
 
#define TISCI_MSG_SET_DEVICE                    (0x0200U)
#define TISCI_MSG_GET_DEVICE                    (0x0201U)
#define TISCI_MSG_SET_DEVICE_RESETS             (0x0202U)
#define TISCI_MSG_DEVICE_DROP_POWERUP_REF       (0x0203U)
 
#define TISCI_MSG_PREPARE_SLEEP                 (0x0300U)
#define TISCI_MSG_ENTER_SLEEP                   (0x0301U)
 
/*
 * NOTE: These can likely be marked reserved here and defined in a
 * tisci_protocol_priv.h?
 */
#define TISCI_MSG_SYNC_RESUME                   (0x0302U)
#define TISCI_MSG_CONTINUE_RESUME               (0x0303U)
#define TISCI_MSG_CORE_RESUME                   (0x0304U)
#define TISCI_MSG_ABORT_ENTER_SLEEP             (0x0305U)
#define TISCI_MSG_LPM_WAKE_REASON               (0x0306U)
#define TISCI_MSG_SET_IO_ISOLATION              (0x0307U)
 
#define TISCI_MSG_FIRMWARE_LOAD                 (0x8105U)
#define MSG_FIRMWARE_LOAD_RESULT                (0x8805U)
 
#define TISCI_MSG_SET_FWL_REGION                (0x9000U)
 
#define TISCI_MSG_GET_FWL_REGION                (0x9001U)
 
#define TISCI_MSG_CHANGE_FWL_OWNER              (0x9002U)
 
#define TISCI_MSG_SA2UL_SET_DKEK                (0x9003U)
 
#define TISCI_MSG_SA2UL_RELEASE_DKEK            (0x9004U)
 
#define TISCI_MSG_KEYSTORE_IMPORT_SKEY          (0x9005U)
 
#define TISCI_MSG_KEYSTORE_ERASE_SKEY           (0x9006U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9007             (0x9007U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9008             (0x9008U)
 
#define TISCI_MSG_SET_ISC_REGION                (0x9009U)
 
#define TISCI_MSG_GET_ISC_REGION                (0x900AU)
 
#define TISCI_MSG_FWL_EXCP_NOTIFICATION         (0x900BU)
 
#define TISCI_MSG_OPEN_DEBUG_FWLS               (0x900CU)
 
#define TISCI_MSG_KEYSTORE_WRITE                (0x900DU)
 
#define TISCI_MSG_KEYSTORE_EXPORT_ALL           (0x900EU)
 
#define TISCI_MSG_KEYSTORE_IMPORT_ALL           (0x900FU)
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9010             (0x9010U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9011             (0x9011U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9012             (0x9012U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9013             (0x9013U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9014             (0x9014U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9015             (0x9015U)
 
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9016             (0x9016U)
 
#define TISCI_MSG_SA2UL_AUTH_RES_ACQUIRE        (0x9017U)
 
#define TISCI_MSG_SA2UL_AUTH_RES_RELEASE        (0x9018U)
 
/* Reserved ID not for (re)use */
#define TISCI_MSG_SEC_RESERVED_9020             (0x9020U)
 
#define TISCI_MSG_GET_SOC_UID                   (0x9021U)
 
/*********************************************************/
/* Messages for handling extended OTP area */
 
#define TISCI_MSG_READ_OTP_MMR                  (0x9022U)
 
#define TISCI_MSG_WRITE_OTP_ROW                 (0x9023U)
 
#define TISCI_MSG_LOCK_OTP_ROW                  (0x9024U)
 
#define TISCI_MSG_SOFT_LOCK_OTP_WRITE_GLOBAL    (0x9025U)
 
#define TISCI_MSG_GET_OTP_ROW_LOCK_STATUS       (0x9026U)
 
#define TISCI_MSG_RSVD_OTP_1                    (0x9027U)
 
#define TISCI_MSG_RSVD_OTP_2                    (0x9028U)
 
#define TISCI_MSG_SA2UL_GET_DKEK                (0x9029U)
 
#define TISCI_MSG_SEC_HANDOVER                  (0x9030U)
 
/******************************************************/
 
/* Keywriter TISCI message to write keys from a certificate  */
#define TISCI_MSG_KEY_WRITER                    (0x9031U)
 
#define TISCI_MSG_WRITE_SWREV                   (0x9032U)
 
#define TISCI_MSG_READ_SWREV                    (0x9033U)
 
#define TISCI_MSG_READ_KEYCNT_KEYREV            (0x9034U)
 
#define TISCI_MSG_WRITE_KEYREV                  (0x9035U)
 
/* Processor Control APIs */
 
#define TISCI_MSG_PROC_REQUEST          (0xC000U)
 
#define TISCI_MSG_PROC_RELEASE          (0xC001U)
 
#define TISCI_MSG_PROC_HANDOVER         (0xC005U)
 
#define TISCI_MSG_PROC_SET_CONFIG       (0xC100U)
 
#define TISCI_MSG_PROC_SET_CONTROL      (0xC101U)
 
#define TISCI_MSG_PROC_GET_STATUS       (0xC400U)
 
#define TISCI_MSG_PROC_WAIT_STATUS      (0xC401U)
 
#define TISCI_MSG_PROC_AUTH_BOOT        (0xC120U)
 
/* RM IDs */
 
#define TISCI_MSG_RM_GET_RESOURCE_RANGE         (0x1500U)
 
#define TISCI_MSG_RM_IRQ_SET                    (0x1000U)
 
#define TISCI_MSG_RM_IRQ_RELEASE                (0x1001U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1100              (0x1100U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1101              (0x1101U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1102              (0x1102U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1103              (0x1103U)
 
#define TISCI_MSG_RM_RING_CFG                   (0x1110U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1111              (0x1111U)
 
#define TISCI_MSG_RM_RING_MON_CFG               (0x1120U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1200              (0x1200U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1201              (0x1201U)
 
#define TISCI_MSG_RM_UDMAP_TX_CH_CFG            (0x1205U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1206              (0x1206U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1210              (0x1210U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1211              (0x1211U)
 
#define TISCI_MSG_RM_UDMAP_RX_CH_CFG            (0x1215U)
#define TISCI_MSG_RM_RESERVED_1216              (0x1216U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1220              (0x1220U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1221              (0x1221U)
 
#define TISCI_MSG_RM_UDMAP_FLOW_CFG             (0x1230U)
 
#define TISCI_MSG_RM_UDMAP_FLOW_SIZE_THRESH_CFG (0x1231U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1232              (0x1232U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1233              (0x1233U)
 
#define TISCI_MSG_RM_UDMAP_FLOW_DELEGATE        (0x1234U)
 
#define TISCI_MSG_RM_UDMAP_GCFG_CFG             (0x1240U)
/* Reserved ID not for (re)use */
#define TISCI_MSG_RM_RESERVED_1241              (0x1241U)
 
#define TISCI_MSG_RM_PSIL_PAIR                  (0x1280U)
 
#define TISCI_MSG_RM_PSIL_UNPAIR                (0x1281U)
 
#define TISCI_MSG_RM_PSIL_READ                  (0x1282U)
 
#define TISCI_MSG_RM_PSIL_WRITE                 (0x1283U)
 
#define TISCI_MSG_RM_PROXY_CFG                  (0x1300U)
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* TISCI_PROTOCOL_H */