| /* |
| * Copyright (C) 2016 Freescale Semiconductor, Inc. |
| * Copyright 2017 NXP |
| * |
| * SPDX-License-Identifier: GPL-2.0+ |
| */ |
| |
| /*! |
| * Header file containing the public API for the System Controller (SC) |
| * Miscellaneous (MISC) function. |
| * |
| * @addtogroup MISC_SVC (SVC) Miscellaneous Service |
| * |
| * Module for the Miscellaneous (MISC) service. |
| * |
| * @{ |
| */ |
| |
| #ifndef _SC_MISC_API_H |
| #define _SC_MISC_API_H |
| |
| /* Includes */ |
| |
| #include <soc/imx8/sc/types.h> |
| #include <soc/imx8/sc/svc/rm/api.h> |
| |
| /* Defines */ |
| |
| /*! |
| * @name Defines for type widths |
| */ |
| /*@{*/ |
| #define SC_MISC_DMA_GRP_W 5 /* Width of sc_misc_dma_group_t */ |
| /*@}*/ |
| |
| /*! Max DMA channel priority group */ |
| #define SC_MISC_DMA_GRP_MAX 31 |
| |
| /*! |
| * @name Defines for sc_misc_boot_status_t |
| */ |
| /*@{*/ |
| #define SC_MISC_BOOT_STATUS_SUCCESS 0 /* Success */ |
| #define SC_MISC_BOOT_STATUS_SECURITY 1 /* Security violation */ |
| /*@}*/ |
| |
| /*! |
| * @name Defines for sc_misc_seco_auth_cmd_t |
| */ |
| /*@{*/ |
| #define SC_MISC_SECO_AUTH_SECO_FW 0 /* SECO Firmware */ |
| #define SC_MISC_SECO_AUTH_HDMI_TX_FW 1 /* HDMI TX Firmware */ |
| #define SC_MISC_SECO_AUTH_HDMI_RX_FW 2 /* HDMI RX Firmware */ |
| /*@}*/ |
| |
| /*! |
| * @name Defines for sc_misc_temp_t |
| */ |
| /*@{*/ |
| #define SC_MISC_TEMP 0 /* Temp sensor */ |
| #define SC_MISC_TEMP_HIGH 1 /* Temp high alarm */ |
| #define SC_MISC_TEMP_LOW 2 /* Temp low alarm */ |
| /*@}*/ |
| |
| /* Types */ |
| |
| /*! |
| * This type is used to store a DMA channel priority group. |
| */ |
| typedef uint8_t sc_misc_dma_group_t; |
| |
| /*! |
| * This type is used report boot status. |
| */ |
| typedef uint8_t sc_misc_boot_status_t; |
| |
| /*! |
| * This type is used to issue SECO authenticate commands. |
| */ |
| typedef uint8_t sc_misc_seco_auth_cmd_t; |
| |
| /*! |
| * This type is used report boot status. |
| */ |
| typedef uint8_t sc_misc_temp_t; |
| |
| /* Functions */ |
| |
| /*! |
| * @name Control Functions |
| * @{ |
| */ |
| |
| /*! |
| * This function sets a miscellaneous control value. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] resource resource the control is associated with |
| * @param[in] ctrl control to change |
| * @param[in] val value to apply to the control |
| * |
| * @return Returns an error code (SC_ERR_NONE = success). |
| * |
| * Return errors: |
| * - SC_PARM if arguments out of range or invalid, |
| * - SC_ERR_NOACCESS if caller's partition is not the resource owner or parent |
| * of the owner |
| * |
| * Refer to the [Control List](@ref CONTROLS) for valid control values. |
| */ |
| sc_err_t sc_misc_set_control(sc_ipc_t ipc, sc_rsrc_t resource, |
| sc_ctrl_t ctrl, uint32_t val); |
| |
| /*! |
| * This function gets a miscellaneous control value. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] resource resource the control is associated with |
| * @param[in] ctrl control to get |
| * @param[out] val pointer to return the control value |
| * |
| * @return Returns an error code (SC_ERR_NONE = success). |
| * |
| * Return errors: |
| * - SC_PARM if arguments out of range or invalid, |
| * - SC_ERR_NOACCESS if caller's partition is not the resource owner or parent |
| * of the owner |
| * |
| * Refer to the [Control List](@ref CONTROLS) for valid control values. |
| */ |
| sc_err_t sc_misc_get_control(sc_ipc_t ipc, sc_rsrc_t resource, |
| sc_ctrl_t ctrl, uint32_t *val); |
| |
| /* @} */ |
| |
| /*! |
| * @name DMA Functions |
| * @{ |
| */ |
| |
| /*! |
| * This function configures the max DMA channel priority group for a |
| * partition. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] pt handle of partition to assign \a max |
| * @param[in] max max priority group (0-31) |
| * |
| * @return Returns an error code (SC_ERR_NONE = success). |
| * |
| * Return errors: |
| * - SC_PARM if arguments out of range or invalid, |
| * - SC_ERR_NOACCESS if caller's partition is not the parent |
| * of the affected partition |
| * |
| * Valid \a max range is 0-31 with 0 being the lowest and 31 the highest. |
| * Default is the max priority group for the parent partition of \a pt. |
| */ |
| sc_err_t sc_misc_set_max_dma_group(sc_ipc_t ipc, sc_rm_pt_t pt, |
| sc_misc_dma_group_t max); |
| |
| /*! |
| * This function configures the priority group for a DMA channel. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] resource DMA channel resource |
| * @param[in] group priority group (0-31) |
| * |
| * @return Returns an error code (SC_ERR_NONE = success). |
| * |
| * Return errors: |
| * - SC_PARM if arguments out of range or invalid, |
| * - SC_ERR_NOACCESS if caller's partition is not the owner or parent |
| * of the owner of the DMA channel |
| * |
| * Valid \a group range is 0-31 with 0 being the lowest and 31 the highest. |
| * The max value of \a group is limited by the partition max set using |
| * sc_misc_set_max_dma_group(). |
| */ |
| sc_err_t sc_misc_set_dma_group(sc_ipc_t ipc, sc_rsrc_t resource, |
| sc_misc_dma_group_t group); |
| |
| /* @} */ |
| |
| /*! |
| * @name Security Functions |
| * @{ |
| */ |
| |
| /*! |
| * This function loads a SECO image. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] addr_src address of image source |
| * @param[in] addr_dst address of image destination |
| * @param[in] len lenth of image to load |
| * @param[in] fw true = firmware load |
| * |
| * @return Returns an error code (SC_ERR_NONE = success). |
| * |
| * This is used to load images via the SECO. Examples include SECO |
| * Firmware and IVT/CSF data used for authentication. These are usually |
| * loaded into SECO TCM. \a addr_src is in secure memory. |
| */ |
| sc_err_t sc_misc_seco_image_load(sc_ipc_t ipc, uint32_t addr_src, |
| uint32_t addr_dst, uint32_t len, bool fw); |
| |
| /*! |
| * This function is used to authenticate a SECO image or command. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] cmd authenticate command |
| * @param[in] addr_meta address of metadata |
| * |
| * @return Returns an error code (SC_ERR_NONE = success). |
| * |
| * This is used to authenticate a SECO image or issue a security |
| * command. \a addr_meta often points to an IVT in SECO TCM. |
| */ |
| sc_err_t sc_misc_seco_authenticate(sc_ipc_t ipc, |
| sc_misc_seco_auth_cmd_t cmd, |
| uint32_t addr_meta); |
| |
| /* @} */ |
| |
| /*! |
| * @name Debug Functions |
| * @{ |
| */ |
| |
| /*! |
| * This function is used output a debug character from the SCU UART. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] ch character to output |
| */ |
| void sc_misc_debug_out(sc_ipc_t ipc, uint8_t ch); |
| |
| /*! |
| * This function starts/stops emulation waveform capture. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] enable flag to enable/disable capture |
| * |
| * @return Returns an error code (SC_ERR_NONE = success). |
| * |
| * Return errors: |
| * - SC_ERR_UNAVAILABLE if not running on emulation |
| */ |
| sc_err_t sc_misc_waveform_capture(sc_ipc_t ipc, bool enable); |
| |
| /* @} */ |
| |
| /*! |
| * @name Other Functions |
| * @{ |
| */ |
| |
| /*! |
| * This function configures the ARI match value for PCIe/SATA resources. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] resource match resource |
| * @param[in] resource_mst PCIe/SATA master to match |
| * @param[in] ari ARI to match |
| * @param[in] enable enable match or not |
| * |
| * @return Returns an error code (SC_ERR_NONE = success). |
| * |
| * Return errors: |
| * - SC_PARM if arguments out of range or invalid, |
| * - SC_ERR_NOACCESS if caller's partition is not the owner or parent |
| * of the owner of the resource and translation |
| * |
| * For PCIe, the ARI is the 16-bit value that includes the bus number, |
| * device number, and function number. For SATA, this value includes the |
| * FISType and PM_Port. |
| */ |
| sc_err_t sc_misc_set_ari(sc_ipc_t ipc, sc_rsrc_t resource, |
| sc_rsrc_t resource_mst, uint16_t ari, bool enable); |
| |
| /*! |
| * This function reports boot status. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] status boot status |
| * |
| * This is used by SW partitions to report status of boot. This is |
| * normally used to report a boot failure. |
| */ |
| void sc_misc_boot_status(sc_ipc_t ipc, sc_misc_boot_status_t status); |
| |
| /*! |
| * This function tells the SCFW that a CPU is done booting. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] cpu CPU that is done booting |
| * |
| * This is called by early booting CPUs to report they are done with |
| * initialization. After starting early CPUs, the SCFW halts the |
| * booting process until they are done. During this time, early |
| * CPUs can call the SCFW with lower latency as the SCFW is idle. |
| * |
| * @return Returns an error code (SC_ERR_NONE = success). |
| * |
| * Return errors: |
| * - SC_PARM if arguments out of range or invalid, |
| * - SC_ERR_NOACCESS if caller's partition is not the CPU owner |
| */ |
| sc_err_t sc_misc_boot_done(sc_ipc_t ipc, sc_rsrc_t cpu); |
| |
| /*! |
| * This function reads a given fuse word index. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] word fuse word index |
| * @param[out] val fuse read value |
| * |
| * @return Returns and error code (SC_ERR_NONE = success). |
| * |
| * Return errors codes: |
| * - SC_ERR_PARM if word fuse index param out of range or invalid |
| * - SC_ERR_NOACCESS if read operation fail |
| * - SC_ERR_LOCKED if read operation is locked |
| */ |
| sc_err_t sc_misc_otp_fuse_read(sc_ipc_t ipc, uint32_t word, uint32_t *val); |
| |
| /*! |
| * This function sets a temp sensor alarm. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] resource resource with sensor |
| * @param[in] temp alarm to set |
| * @param[in] celsius whole part of temp to set |
| * @param[in] tenths fractional part of temp to set |
| * |
| * @return Returns and error code (SC_ERR_NONE = success). |
| * |
| * Return errors codes: |
| * - SC_ERR_PARM if parameters invalid |
| */ |
| sc_err_t sc_misc_set_temp(sc_ipc_t ipc, sc_rsrc_t resource, |
| sc_misc_temp_t temp, int16_t celsius, int8_t tenths); |
| |
| /*! |
| * This function gets a temp sensor value. |
| * |
| * @param[in] ipc IPC handle |
| * @param[in] resource resource with sensor |
| * @param[in] temp value to get (sensor or alarm) |
| * @param[out] celsius whole part of temp to get |
| * @param[out] tenths fractional part of temp to get |
| * |
| * @return Returns and error code (SC_ERR_NONE = success). |
| * |
| * Return errors codes: |
| * - SC_ERR_PARM if parameters invalid |
| */ |
| sc_err_t sc_misc_get_temp(sc_ipc_t ipc, sc_rsrc_t resource, |
| sc_misc_temp_t temp, int16_t * celsius, |
| int8_t * tenths); |
| |
| /*! |
| * This function returns the current status of the ON/OFF button. |
| * |
| * @param[in] ipc IPC handle |
| * @param[out] status pointer to return button status |
| */ |
| void sc_misc_get_button_status(sc_ipc_t ipc, bool *status); |
| |
| /* @} */ |
| |
| #endif /* _SC_MISC_API_H */ |
| |
| /**@}*/ |