diff options
Diffstat (limited to 'stub/memory_gpio_access_library/client/include/stub')
| -rw-r--r-- | stub/memory_gpio_access_library/client/include/stub/el_gpio.h | 802 | ||||
| -rw-r--r-- | stub/memory_gpio_access_library/client/include/stub/el_mem.h | 396 |
2 files changed, 1198 insertions, 0 deletions
diff --git a/stub/memory_gpio_access_library/client/include/stub/el_gpio.h b/stub/memory_gpio_access_library/client/include/stub/el_gpio.h new file mode 100644 index 00000000..a9d5639b --- /dev/null +++ b/stub/memory_gpio_access_library/client/include/stub/el_gpio.h @@ -0,0 +1,802 @@ +/* + * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file el_gpio.h + * @brief el_gpio function header file + */ + +#ifndef MEMORY_GPIO_ACCESS_LIBRARY_CLIENT_INCLUDE_NATIVE_SERVICE_EL_GPIO_H_ +#define MEMORY_GPIO_ACCESS_LIBRARY_CLIENT_INCLUDE_NATIVE_SERVICE_EL_GPIO_H_ + +/** @addtogroup BaseSystem + * @{ + */ +/** @addtogroup native_service + * @ingroup BaseSystem + * @{ + */ +/** @addtogroup memory_gpio_access_library + * @ingroup native_service + * @{ + */ + +#ifdef __cplusplus +extern "C" { +#endif +#include <stdbool.h> + +/** + * \~english Definitions of the GPIO Control Symbol + */ +enum { + EL_GPO_SUB_RST_N = 0 , + EL_GPO_NAVI_DET, + EL_GPI_ILG_RST_N, + EL_GPI_GPS_INT, + EL_GPO_GPS_P_OFF, + EL_GPO_CP_RST_N, + EL_GPO_TP_RST_N, + EL_GPI_SEC_ST1, + EL_GPI_SEC_ST0, + EL_GPO__CWORD52__RST, + EL_GPI__CWORD32__INT, + EL_GPO__CWORD32__RST, + EL_GPO_XM_RST, + EL_GPO_NFC_RST, + EL_GPO_USB1_PWEN, + EL_GPI_USB1_OVC, + EL_GPO__CWORD52__VUP, + EL_GPO_WL_EN, + EL_GPO_BT_EN, + EL_GPO_AVB_RST_N, + EL_GPO_SEC_RST_N, + EL_SPI_NAVI_REQ, + EL_SPI_NAVI_RDY, + EL_GPI_USB0_QVC, + EL_GPO_USB0_PWE, + EL_GPO_GVIFTX1_RST_N, + EL_GPO_GVIFTX0_RST_N, + EL_GPO_EMMC_ON_N, + EL_SPI_GVIF_D_UCS, + EL_GPO__CWORD65__RST_N, + EL_GPO_GVIFRX_RST_N, + EL_GPI_IOEX_INT, + EL_GPO_FBRQ, + EL_GPO_IOEX_RST_N, + EL_GPI_GVIFTX1_GPIO3, + EL_GPI_DARC_INT, + EL_GPI_GVIFTX0_GPIO3, + EL_GPI_GVIF_REQ_INT, + EL_GPI_ACC_DET_OUT, + EL_GPI_GVIFRX_GPIO3, + EL_GPO_DTCP_RST_N, + EL_NAVI_NMI_N, + EL_GPI_SDPCHK, + EL_GPO_XM_SHDN, + EL_GPI_GVIF_D_REQ_INT, + EL_SPI_GVIF_D_DCS, + EL_GPO_EMMC_PU_ON, + EL_GPIO_GVIFRX_GPIO0, + EL_GPI_GVIFRX_GPIO2, + EL_GPI_GVIFRX_LOS, + EL_GPIO_GVIFTX0_GPIO0, + EL_GPI_GVIFTX0_GPIO2, + EL_GPIO_GVIFTX1_GPIO0, + EL_GPI_GVIFTX1_GPIO2, + EL_GPO_USBHUB_RST, + EL_GPI__CWORD65__BOOT_ERR, + EL_GPO_CKECNT, + EL_GPO_SDPCLR, + EL_GPO_SENSOR_RST, + EL_GPI_SENSOR_INT, + EL_GPO_DAC_MUTE, + EL_GPO_DSRC_PON, + EL_GPI_2PULSE_REV, + EL_GPI_ILL_DET, + EL_GPI_DAB_DET, + EL_GPI_FAN_DET, + + EL_GPO_SOC_DIAG_OUT, + EL_GPI_SOC_DIAG_IN, + + EL_GPIO_SYMBOL_MAX, +}; + +/** + * \~english Rising level trigger + */ +#define EL_GPIO_IRQ_TRIGGER_RISING (0x01) + +/** + * \~english Falling level trigger + */ +#define EL_GPIO_IRQ_TRIGGER_FALLING (0x02) + +/** + * \~english High level trigger + */ +#define EL_GPIO_IRQ_TRIGGER_HIGH (0x04) + +/** + * \~english Low level trigger + */ +#define EL_GPIO_IRQ_TRIGGER_LOW (0x08) + +/** + * \~english Trigger mask + */ +#define EL_GPIO_IRQ_TRIGGER_MASK (EL_GPIO_IRQ_TRIGGER_RISING | \ + EL_GPIO_IRQ_TRIGGER_FALLING | \ + EL_GPIO_IRQ_TRIGGER_HIGH | \ + EL_GPIO_IRQ_TRIGGER_LOW) + +/** + * \~english None timeout + */ +#define EL_GPIO_IRQ_NO_TIMEOUT (-1) + +/**\ingroup EL_Gpio_write +* \~english @par Brief +* Write data to specified GPIO. +* \~english @param [in] symbol +* int - symbol(Definitions of the GPIO Control Symbol) +* \~english @param [in] value +* bool - setting value(0 or 1) +* \~english @par +* Definitions of the GPIO Control Symbol +* \~english @code +* enum { +* EL_GPO_SUB_RST_N = 0 , +* EL_GPO_NAVI_DET, +* EL_GPI_ILG_RST_N, +* EL_GPI_GPS_INT, +* EL_GPO_GPS_P_OFF, +* EL_GPO_CP_RST_N, +* EL_GPO_TP_RST_N, +* EL_GPI_SEC_ST1, +* EL_GPI_SEC_ST0, +* EL_GPO__CWORD52__RST, +* EL_GPI__CWORD32__INT, +* EL_GPO__CWORD32__RST, +* EL_GPO_XM_RST, +* EL_GPO_NFC_RST, +* EL_GPO_USB1_PWEN, +* EL_GPI_USB1_OVC, +* EL_GPO__CWORD52__VUP, +* EL_GPO_WL_EN, +* EL_GPO_BT_EN, +* EL_GPO_AVB_RST_N, +* EL_GPO_SEC_RST_N, +* EL_SPI_NAVI_REQ, +* EL_SPI_NAVI_RDY, +* EL_GPI_USB0_QVC, +* EL_GPO_USB0_PWE, +* EL_GPO_GVIFTX1_RST_N, +* EL_GPO_GVIFTX0_RST_N, +* EL_GPO_EMMC_ON_N, +* EL_SPI_GVIF_D_UCS, +* EL_GPO__CWORD65__RST_N, +* EL_GPO_GVIFRX_RST_N, +* EL_GPI_IOEX_INT, +* EL_GPO_FBRQ, +* EL_GPO_IOEX_RST_N, +* EL_GPI_GVIFTX1_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_GVIF_REQ_INT, +* EL_GPI_ACC_DET_OUT, +* EL_GPI_GVIFRX_GPIO3, +* EL_GPO_DTCP_RST_N, +* EL_NAVI_NMI_N, +* EL_GPI_SDPCHK, +* EL_GPO_XM_SHDN, +* EL_GPI_GVIF_D_REQ_INT, +* EL_SPI_GVIF_D_DCS, +* EL_GPO_EMMC_PU_ON, +* EL_GPIO_GVIFRX_GPIO0, +* EL_GPI_GVIFRX_GPIO2, +* EL_GPI_GVIFRX_LOS, +* EL_GPIO_GVIFTX0_GPIO0, +* EL_GPI_GVIFTX0_GPIO2, +* EL_GPIO_GVIFTX1_GPIO0, +* EL_GPI_GVIFTX1_GPIO2, +* EL_GPO_USBHUB_RST, +* EL_GPI__CWORD65__BOOT_ERR, +* EL_GPO_CKECNT, +* EL_GPO_SDPCLR, +* EL_GPO_SENSOR_RST, +* EL_GPI_SENSOR_INT, +* EL_GPO_DAC_MUTE, +* EL_GPO_DSRC_PON, +* EL_GPI_2PULSE_REV, +* EL_GPI_ILL_DET, +* EL_GPI_DAB_DET, +* EL_GPI_FAN_DET, +* EL_GPO_SOC_DIAG_OUT, +* EL_GPI_SOC_DIAG_IN, +* EL_GPIO_SYMBOL_MAX, +* }; +* @endcode +* \~english @retval 0 Success +* \~english @retval -1 Error:Set errno according to error type when error occurs. +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - The value of symbol is less than 0 or greater than EL_GPIO_SYMBOL_MAX-1. [-1] +* - syscall error(open(), ioctl()). [-1] +* \~english @par Detail +* - There is authority to access the specified GPIO, writing data is possiable only\n +* when GPIO port is an output port. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see EL_Gpio_read +*/ +int EL_Gpio_write(int symbol , bool value); // NOLINT[readability/naming] + +/** \ingroup EL_Gpio_read +* \~english @par Brief +* Read data from specified GPIO. +* \~english @param [in] symbol +* int - symbol(Definitions of the GPIO Control Symbol) +* \~english @param [out] value +* bool * - setting value +* \~english @par +* Definitions of the GPIO Control Symbol +* \~english @code +* enum { +* EL_GPO_SUB_RST_N = 0 , +* EL_GPO_NAVI_DET, +* EL_GPI_ILG_RST_N, +* EL_GPI_GPS_INT, +* EL_GPO_GPS_P_OFF, +* EL_GPO_CP_RST_N, +* EL_GPO_TP_RST_N, +* EL_GPI_SEC_ST1, +* EL_GPI_SEC_ST0, +* EL_GPO__CWORD52__RST, +* EL_GPI__CWORD32__INT, +* EL_GPO__CWORD32__RST, +* EL_GPO_XM_RST, +* EL_GPO_NFC_RST, +* EL_GPO_USB1_PWEN, +* EL_GPI_USB1_OVC, +* EL_GPO__CWORD52__VUP, +* EL_GPO_WL_EN, +* EL_GPO_BT_EN, +* EL_GPO_AVB_RST_N, +* EL_GPO_SEC_RST_N, +* EL_SPI_NAVI_REQ, +* EL_SPI_NAVI_RDY, +* EL_GPI_USB0_QVC, +* EL_GPO_USB0_PWE, +* EL_GPO_GVIFTX1_RST_N, +* EL_GPO_GVIFTX0_RST_N, +* EL_GPO_EMMC_ON_N, +* EL_SPI_GVIF_D_UCS, +* EL_GPO__CWORD65__RST_N, +* EL_GPO_GVIFRX_RST_N, +* EL_GPI_IOEX_INT, +* EL_GPO_FBRQ, +* EL_GPO_IOEX_RST_N, +* EL_GPI_GVIFTX1_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_GVIF_REQ_INT, +* EL_GPI_ACC_DET_OUT, +* EL_GPI_GVIFRX_GPIO3, +* EL_GPO_DTCP_RST_N, +* EL_NAVI_NMI_N, +* EL_GPI_SDPCHK, +* EL_GPO_XM_SHDN, +* EL_GPI_GVIF_D_REQ_INT, +* EL_SPI_GVIF_D_DCS, +* EL_GPO_EMMC_PU_ON, +* EL_GPIO_GVIFRX_GPIO0, +* EL_GPI_GVIFRX_GPIO2, +* EL_GPI_GVIFRX_LOS, +* EL_GPIO_GVIFTX0_GPIO0, +* EL_GPI_GVIFTX0_GPIO2, +* EL_GPIO_GVIFTX1_GPIO0, +* EL_GPI_GVIFTX1_GPIO2, +* EL_GPO_USBHUB_RST, +* EL_GPI__CWORD65__BOOT_ERR, +* EL_GPO_CKECNT, +* EL_GPO_SDPCLR, +* EL_GPO_SENSOR_RST, +* EL_GPI_SENSOR_INT, +* EL_GPO_DAC_MUTE, +* EL_GPO_DSRC_PON, +* EL_GPI_2PULSE_REV, +* EL_GPI_ILL_DET, +* EL_GPI_DAB_DET, +* EL_GPI_FAN_DET, +* EL_GPO_SOC_DIAG_OUT, +* EL_GPI_SOC_DIAG_IN, +* EL_GPIO_SYMBOL_MAX, +* }; +* @endcode +* \~english @retval 0 Success +* \~english @retval -1 Error:Set errno according to error type when error occurs. +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - The value of symbol is less than 0 or greater than EL_GPIO_SYMBOL_MAX-1. [-1] +* - syscall error(open(), ioctl()). [-1] +* \~english @par Detail +* - Reading data is possiable when there is authority to access the specified GPIO. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see EL_Gpio_write +*/ +int EL_Gpio_read(int symbol , bool *value); // NOLINT[readability/naming] + +/** \ingroup EL_Gpio_attachInterruptControl +* \~english @par Brief +* Register interruption control of specified GPIO. +* \~english @param [in] symbol +* int - symbol(Definitions of the GPIO Control Symbol) +* \~english @param [in] irq_flags +* unsigned long - Interruption control flag of GPIO. +* \~english @par +* Definitions of the GPIO Control Symbol +* \~english @code +* enum { +* EL_GPO_SUB_RST_N = 0 , +* EL_GPO_NAVI_DET, +* EL_GPI_ILG_RST_N, +* EL_GPI_GPS_INT, +* EL_GPO_GPS_P_OFF, +* EL_GPO_CP_RST_N, +* EL_GPO_TP_RST_N, +* EL_GPI_SEC_ST1, +* EL_GPI_SEC_ST0, +* EL_GPO__CWORD52__RST, +* EL_GPI__CWORD32__INT, +* EL_GPO__CWORD32__RST, +* EL_GPO_XM_RST, +* EL_GPO_NFC_RST, +* EL_GPO_USB1_PWEN, +* EL_GPI_USB1_OVC, +* EL_GPO__CWORD52__VUP, +* EL_GPO_WL_EN, +* EL_GPO_BT_EN, +* EL_GPO_AVB_RST_N, +* EL_GPO_SEC_RST_N, +* EL_SPI_NAVI_REQ, +* EL_SPI_NAVI_RDY, +* EL_GPI_USB0_QVC, +* EL_GPO_USB0_PWE, +* EL_GPO_GVIFTX1_RST_N, +* EL_GPO_GVIFTX0_RST_N, +* EL_GPO_EMMC_ON_N, +* EL_SPI_GVIF_D_UCS, +* EL_GPO__CWORD65__RST_N, +* EL_GPO_GVIFRX_RST_N, +* EL_GPI_IOEX_INT, +* EL_GPO_FBRQ, +* EL_GPO_IOEX_RST_N, +* EL_GPI_GVIFTX1_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_GVIF_REQ_INT, +* EL_GPI_ACC_DET_OUT, +* EL_GPI_GVIFRX_GPIO3, +* EL_GPO_DTCP_RST_N, +* EL_NAVI_NMI_N, +* EL_GPI_SDPCHK, +* EL_GPO_XM_SHDN, +* EL_GPI_GVIF_D_REQ_INT, +* EL_SPI_GVIF_D_DCS, +* EL_GPO_EMMC_PU_ON, +* EL_GPIO_GVIFRX_GPIO0, +* EL_GPI_GVIFRX_GPIO2, +* EL_GPI_GVIFRX_LOS, +* EL_GPIO_GVIFTX0_GPIO0, +* EL_GPI_GVIFTX0_GPIO2, +* EL_GPIO_GVIFTX1_GPIO0, +* EL_GPI_GVIFTX1_GPIO2, +* EL_GPO_USBHUB_RST, +* EL_GPI__CWORD65__BOOT_ERR, +* EL_GPO_CKECNT, +* EL_GPO_SDPCLR, +* EL_GPO_SENSOR_RST, +* EL_GPI_SENSOR_INT, +* EL_GPO_DAC_MUTE, +* EL_GPO_DSRC_PON, +* EL_GPI_2PULSE_REV, +* EL_GPI_ILL_DET, +* EL_GPI_DAB_DET, +* EL_GPI_FAN_DET, +* EL_GPO_SOC_DIAG_OUT, +* EL_GPI_SOC_DIAG_IN, +* EL_GPIO_SYMBOL_MAX, +* }; +* @endcode +* \~english @par +* Interruption control flag of GPIO +* - EL_GPIO_IRQ_TRIGGER_RISING :Rising level trigger +* - EL_GPIO_IRQ_TRIGGER_FALLING :Falling level trigger +* - EL_GPIO_IRQ_TRIGGER_HIGH :High level trigger +* - EL_GPIO_IRQ_TRIGGER_LOW :Low level trigger +* \~english @retval 0 Success +* \~english @retval -1 Error +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - Flag specified by irq_flags is not defined flag. [-1] +* - The value of symbol is less than 0 or greater than EL_GPIO_SYMBOL_MAX-1. [-1] +* - syscall error(open(), ioctl()). [-1] +* \~english @par Detail +* - Register interruption control of specified GPIO. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see EL_Gpio_detachInterruptControl +*/ +int EL_Gpio_attachInterruptControl(int symbol , unsigned long irq_flags); // NOLINT [readability/nolint] + +/** \ingroup EL_Gpio_detachInterruptControl +* \~english @par Brief +* Detach interruption control of specified GPIO. +* \~english @param [in] symbol +* int - symbol(Definitions of the GPIO Control Symbol) +* \~english @par +* Definitions of the GPIO Control Symbol +* \~english @code +* enum { +* EL_GPO_SUB_RST_N = 0 , +* EL_GPO_NAVI_DET, +* EL_GPI_ILG_RST_N, +* EL_GPI_GPS_INT, +* EL_GPO_GPS_P_OFF, +* EL_GPO_CP_RST_N, +* EL_GPO_TP_RST_N, +* EL_GPI_SEC_ST1, +* EL_GPI_SEC_ST0, +* EL_GPO__CWORD52__RST, +* EL_GPI__CWORD32__INT, +* EL_GPO__CWORD32__RST, +* EL_GPO_XM_RST, +* EL_GPO_NFC_RST, +* EL_GPO_USB1_PWEN, +* EL_GPI_USB1_OVC, +* EL_GPO__CWORD52__VUP, +* EL_GPO_WL_EN, +* EL_GPO_BT_EN, +* EL_GPO_AVB_RST_N, +* EL_GPO_SEC_RST_N, +* EL_SPI_NAVI_REQ, +* EL_SPI_NAVI_RDY, +* EL_GPI_USB0_QVC, +* EL_GPO_USB0_PWE, +* EL_GPO_GVIFTX1_RST_N, +* EL_GPO_GVIFTX0_RST_N, +* EL_GPO_EMMC_ON_N, +* EL_SPI_GVIF_D_UCS, +* EL_GPO__CWORD65__RST_N, +* EL_GPO_GVIFRX_RST_N, +* EL_GPI_IOEX_INT, +* EL_GPO_FBRQ, +* EL_GPO_IOEX_RST_N, +* EL_GPI_GVIFTX1_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_GVIF_REQ_INT, +* EL_GPI_ACC_DET_OUT, +* EL_GPI_GVIFRX_GPIO3, +* EL_GPO_DTCP_RST_N, +* EL_NAVI_NMI_N, +* EL_GPI_SDPCHK, +* EL_GPO_XM_SHDN, +* EL_GPI_GVIF_D_REQ_INT, +* EL_SPI_GVIF_D_DCS, +* EL_GPO_EMMC_PU_ON, +* EL_GPIO_GVIFRX_GPIO0, +* EL_GPI_GVIFRX_GPIO2, +* EL_GPI_GVIFRX_LOS, +* EL_GPIO_GVIFTX0_GPIO0, +* EL_GPI_GVIFTX0_GPIO2, +* EL_GPIO_GVIFTX1_GPIO0, +* EL_GPI_GVIFTX1_GPIO2, +* EL_GPO_USBHUB_RST, +* EL_GPI__CWORD65__BOOT_ERR, +* EL_GPO_CKECNT, +* EL_GPO_SDPCLR, +* EL_GPO_SENSOR_RST, +* EL_GPI_SENSOR_INT, +* EL_GPO_DAC_MUTE, +* EL_GPO_DSRC_PON, +* EL_GPI_2PULSE_REV, +* EL_GPI_ILL_DET, +* EL_GPI_DAB_DET, +* EL_GPI_FAN_DET, +* EL_GPO_SOC_DIAG_OUT, +* EL_GPI_SOC_DIAG_IN, +* EL_GPIO_SYMBOL_MAX, +* }; +* @endcode +* \~english @retval 0 Success +* \~english @retval -1 Error +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - The value of symbol is less than 0 or greater than EL_GPIO_SYMBOL_MAX-1. [-1] +* - syscall error(open(), ioctl()). [-1] +* \~english @par Detail +* - Detach interruption control of specified GPIO. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see EL_Gpio_attachInterruptControl +*/ +int EL_Gpio_detachInterruptControl(int symbol); // NOLINT[readability/naming] + +/** \ingroup EL_Gpio_waitInterrupt +* \~english @par Brief +* Waiting interruption of specified GPIO occured without timeout. +* \~english @param [in] symbol +* int - symbol(Definitions of the GPIO Control Symbol) +* \~english @par +* Definitions of the GPIO Control Symbol +* \~english @code +* enum { +* EL_GPO_SUB_RST_N = 0 , +* EL_GPO_NAVI_DET, +* EL_GPI_ILG_RST_N, +* EL_GPI_GPS_INT, +* EL_GPO_GPS_P_OFF, +* EL_GPO_CP_RST_N, +* EL_GPO_TP_RST_N, +* EL_GPI_SEC_ST1, +* EL_GPI_SEC_ST0, +* EL_GPO__CWORD52__RST, +* EL_GPI__CWORD32__INT, +* EL_GPO__CWORD32__RST, +* EL_GPO_XM_RST, +* EL_GPO_NFC_RST, +* EL_GPO_USB1_PWEN, +* EL_GPI_USB1_OVC, +* EL_GPO__CWORD52__VUP, +* EL_GPO_WL_EN, +* EL_GPO_BT_EN, +* EL_GPO_AVB_RST_N, +* EL_GPO_SEC_RST_N, +* EL_SPI_NAVI_REQ, +* EL_SPI_NAVI_RDY, +* EL_GPI_USB0_QVC, +* EL_GPO_USB0_PWE, +* EL_GPO_GVIFTX1_RST_N, +* EL_GPO_GVIFTX0_RST_N, +* EL_GPO_EMMC_ON_N, +* EL_SPI_GVIF_D_UCS, +* EL_GPO__CWORD65__RST_N, +* EL_GPO_GVIFRX_RST_N, +* EL_GPI_IOEX_INT, +* EL_GPO_FBRQ, +* EL_GPO_IOEX_RST_N, +* EL_GPI_GVIFTX1_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_GVIF_REQ_INT, +* EL_GPI_ACC_DET_OUT, +* EL_GPI_GVIFRX_GPIO3, +* EL_GPO_DTCP_RST_N, +* EL_NAVI_NMI_N, +* EL_GPI_SDPCHK, +* EL_GPO_XM_SHDN, +* EL_GPI_GVIF_D_REQ_INT, +* EL_SPI_GVIF_D_DCS, +* EL_GPO_EMMC_PU_ON, +* EL_GPIO_GVIFRX_GPIO0, +* EL_GPI_GVIFRX_GPIO2, +* EL_GPI_GVIFRX_LOS, +* EL_GPIO_GVIFTX0_GPIO0, +* EL_GPI_GVIFTX0_GPIO2, +* EL_GPIO_GVIFTX1_GPIO0, +* EL_GPI_GVIFTX1_GPIO2, +* EL_GPO_USBHUB_RST, +* EL_GPI__CWORD65__BOOT_ERR, +* EL_GPO_CKECNT, +* EL_GPO_SDPCLR, +* EL_GPO_SENSOR_RST, +* EL_GPI_SENSOR_INT, +* EL_GPO_DAC_MUTE, +* EL_GPO_DSRC_PON, +* EL_GPI_2PULSE_REV, +* EL_GPI_ILL_DET, +* EL_GPI_DAB_DET, +* EL_GPI_FAN_DET, +* EL_GPO_SOC_DIAG_OUT, +* EL_GPI_SOC_DIAG_IN, +* EL_GPIO_SYMBOL_MAX, +* }; +* @endcode +* \~english @retval 0 Success +* \~english @retval -1 Error +* \~english @par Prerequisite +* - Interruption of specified GPIO was registered by \ref EL_Gpio_attachInterruptControl. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - The value of symbol is less than 0 or greater than EL_GPIO_SYMBOL_MAX-1. [-1] +* - syscall error(open(), ioctl()). [-1] +* \~english @par Detail +* - Waiting interruption of specified GPIO occured without timeout. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see EL_Gpio_waitInterrupt_timeout +*/ +int EL_Gpio_waitInterrupt(int symbol); // NOLINT[readability/naming] + +/** \ingroup EL_Gpio_waitInterrupt_timeout +* \~english @par Brief +* Waiting interruption of specified GPIO with timeout. +* \~english @param [in] symbol +* int - Symbol(Definitions of the GPIO Control Symbol) +* \~english @param [in] timeout +* int - Timeout of time(unit: jiffies) +* \~english @par +* Definitions of the GPIO Control Symbol +* \~english @code +* enum { +* EL_GPO_SUB_RST_N = 0 , +* EL_GPO_NAVI_DET, +* EL_GPI_ILG_RST_N, +* EL_GPI_GPS_INT, +* EL_GPO_GPS_P_OFF, +* EL_GPO_CP_RST_N, +* EL_GPO_TP_RST_N, +* EL_GPI_SEC_ST1, +* EL_GPI_SEC_ST0, +* EL_GPO__CWORD52__RST, +* EL_GPI__CWORD32__INT, +* EL_GPO__CWORD32__RST, +* EL_GPO_XM_RST, +* EL_GPO_NFC_RST, +* EL_GPO_USB1_PWEN, +* EL_GPI_USB1_OVC, +* EL_GPO__CWORD52__VUP, +* EL_GPO_WL_EN, +* EL_GPO_BT_EN, +* EL_GPO_AVB_RST_N, +* EL_GPO_SEC_RST_N, +* EL_SPI_NAVI_REQ, +* EL_SPI_NAVI_RDY, +* EL_GPI_USB0_QVC, +* EL_GPO_USB0_PWE, +* EL_GPO_GVIFTX1_RST_N, +* EL_GPO_GVIFTX0_RST_N, +* EL_GPO_EMMC_ON_N, +* EL_SPI_GVIF_D_UCS, +* EL_GPO__CWORD65__RST_N, +* EL_GPO_GVIFRX_RST_N, +* EL_GPI_IOEX_INT, +* EL_GPO_FBRQ, +* EL_GPO_IOEX_RST_N, +* EL_GPI_GVIFTX1_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_DARC_INT, +* EL_GPI_GVIFTX0_GPIO3, +* EL_GPI_GVIF_REQ_INT, +* EL_GPI_ACC_DET_OUT, +* EL_GPI_GVIFRX_GPIO3, +* EL_GPO_DTCP_RST_N, +* EL_NAVI_NMI_N, +* EL_GPI_SDPCHK, +* EL_GPO_XM_SHDN, +* EL_GPI_GVIF_D_REQ_INT, +* EL_SPI_GVIF_D_DCS, +* EL_GPO_EMMC_PU_ON, +* EL_GPIO_GVIFRX_GPIO0, +* EL_GPI_GVIFRX_GPIO2, +* EL_GPI_GVIFRX_LOS, +* EL_GPIO_GVIFTX0_GPIO0, +* EL_GPI_GVIFTX0_GPIO2, +* EL_GPIO_GVIFTX1_GPIO0, +* EL_GPI_GVIFTX1_GPIO2, +* EL_GPO_USBHUB_RST, +* EL_GPI__CWORD65__BOOT_ERR, +* EL_GPO_CKECNT, +* EL_GPO_SDPCLR, +* EL_GPO_SENSOR_RST, +* EL_GPI_SENSOR_INT, +* EL_GPO_DAC_MUTE, +* EL_GPO_DSRC_PON, +* EL_GPI_2PULSE_REV, +* EL_GPI_ILL_DET, +* EL_GPI_DAB_DET, +* EL_GPI_FAN_DET, +* EL_GPO_SOC_DIAG_OUT, +* EL_GPI_SOC_DIAG_IN, +* EL_GPIO_SYMBOL_MAX, +* }; +* @endcode +* \~english @retval 0 Success +* \~english @retval -1 Error +* \~english @par Prerequisite +* - Interruption of specified GPIO was registered by \ref EL_Gpio_attachInterruptControl . +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - The value of symbol is less than 0 or greater than EL_GPIO_SYMBOL_MAX-1. [-1] +* - syscall error(open(), ioctl()). [-1] +* \~english @par Detail +* - Waiting interruption of specified GPIO with timeout. +* - If the value of timeout is not greater than 0, timeout will not happened. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see none +*/ +int EL_Gpio_waitInterrupt_timeout(int symbol, int timeout); // NOLINT[readability/naming] + +/** \ingroup EL_Gpio_finalize +* \~english @par Brief +* End processing. +* \~english @retval 0 Return 0 +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - none +* \~english @par Detail +* - Change IO-Expander device to reset status. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see EL_Gpio_write, EL_Gpio_read +*/ +int EL_Gpio_finalize(void); // NOLINT[readability/naming] + +#ifdef __cplusplus +} +#endif // __cplusplus + +/** @}*/ // end of memory_gpio_access_library +/** @}*/ // end of native_service +/** @}*/ // end of BaseSystem +#endif // MEMORY_GPIO_ACCESS_LIBRARY_CLIENT_INCLUDE_NATIVE_SERVICE_EL_GPIO_H_ diff --git a/stub/memory_gpio_access_library/client/include/stub/el_mem.h b/stub/memory_gpio_access_library/client/include/stub/el_mem.h new file mode 100644 index 00000000..b6f68559 --- /dev/null +++ b/stub/memory_gpio_access_library/client/include/stub/el_mem.h @@ -0,0 +1,396 @@ +/* + * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file el_mem.h + * @brief el_mem function header file + */ + +#ifndef MEMORY_GPIO_ACCESS_LIBRARY_CLIENT_INCLUDE_NATIVE_SERVICE_EL_MEM_H_ +#define MEMORY_GPIO_ACCESS_LIBRARY_CLIENT_INCLUDE_NATIVE_SERVICE_EL_MEM_H_ + +/** @addtogroup BaseSystem + * @{ + */ +/** @addtogroup native_service + * @ingroup BaseSystem + * @{ + */ +/** @addtogroup memory_gpio_access_library + * @ingroup native_service + * @{ + */ + +#ifdef __cplusplus +extern "C" { +#endif +#include <stdbool.h> +#include <sys/types.h> + +/** +* \~english Definitions of the Parametar of type +*/ +enum { + EL_MEM_TYPE_REGION_SYS, //!< \~english SYS region + EL_MEM_TYPE_REGION_LOG, //!< \~english LOG region + EL_MEM_TYPE_REGION_COM, //!< \~english COMMUNICATION region + EL_MEM_TYPE_REGION_NAVI, //!< \~english NAVI region + EL_MEM_TYPE_REGION_SH4A, //!< \~english SH4A region + EL_MEM_TYPE_REGION_PRAMFS, //!< \~english PRAMFS region + EL_MEM_TYPE_REGION_STARTUPBGM, //!< \~english STARTUPBGM region + EL_MEM_TYPE_REGION_NAVI_IR, //!< \~english NAVI picture recognition region + EL_MEM_TYPE_REGION_MAX //!< \~english (internal use) +}; + +/** +* \~english Definitions of the Parametar of memory id +*/ +enum { + // SYS region + EL_MEM_ID_SYS_ALL = 0x0001, //!< \~english all SYS region + EL_MEM_ID_SYS_BOOT, //!< \~english particular: BOOT region + + // LOG region + EL_MEM_ID_LOG_ALL = 0x1001, //!< \~english all LOG region + + // COM region + EL_MEM_ID_COM_ALL = 0x2001, //!< \~english all COMMUNICATION region + EL_MEM_ID_COM_SH4A, //!< \~english particular: SH4A abnornal observation + + // NAVI region + EL_MEM_ID_NAVI_ALL = 0x3001, //!< \~english NAVI region + EL_MEM_ID_NAVI_LOG, //!< \~english particular: NAVI(AW) LOG region + + // SH4A region + EL_MEM_ID_SH4A_ALL = 0x4001, //!< \~english SH4A region + EL_MEM_ID_SH4A_SHM, //!< \~english particular: SH4A SH share memory region + + // PRAMFS region NOTE:Can be used only when ROM operation + EL_MEM_ID_PRAMFS_ALL = 0x5001, //!< \~english all PRAMFS region + + // STARTUPBGM region + EL_MEM_ID_STARTUPBGM_ALL = 0x6001, //!< \~english all STARTUPBGM region + + // NAVI region (Picture Recognition: For Image Recognition) + EL_MEM_ID_NAVI_IR_ALL = 0x7001, //!< \~english all NAVI picture recognition region +}; + +/** + * \~english Valid cache_flag + */ +#define EL_MEM_CACHE_VALID 1 + +/** + * \~english Invalid cache_flag + */ +#define EL_MEM_CACHE_INVALID 0 + +/**\ingroup EL_mem_getOffset +* \~english @par Brief +* Get offset of function region according to mem_id. +* \~english @param [in] mem_id +* int - memory id +* \~english @par +* Defined memory id as follows. +* \~english @code +* enum { +* // SYS +* EL_MEM_ID_SYS_ALL = 0x0001, // all SYS region +* EL_MEM_ID_SYS_BOOT, // particular: BOOT region +* // COM +* EL_MEM_ID_COM_ALL = 0x2001, // all COMMUNICATION region +* EL_MEM_ID_COM_SH4A, // particular: SH4A abnornal observation +* // NAVI +* EL_MEM_ID_NAVI_ALL = 0x3001, // NAVI region +* EL_MEM_ID_NAVI_LOG, // particular: NAVI(AW) LOG region +* // SH4A +* EL_MEM_ID_SH4A_ALL = 0x4001, // SH4A region +* EL_MEM_ID_SH4A_SHM, // particular: SH4A SH share memory region +* // PRAMFS NOTE:ROM only +* EL_MEM_ID_PRAMFS_ALL = 0x5001, // all PRAMFS region +* // STARTUPBGM +* EL_MEM_ID_STARTUPBGM_ALL = 0x6001, // all STARTUPBGM region +* // NAVI (Image Recognition) +* EL_MEM_ID_NAVI_IR_ALL = 0x7001, // all NAVI picture recognition region +* }; +* @endcode +* \~english @retval offset Success +* \~english @retval -1 Error +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - Parameter mem_id is not defined.[-1] +* \~english @par Detail +* - Get offset of function region according to mem_id. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see none +*/ +off_t EL_mem_getOffset(int mem_id); // NOLINT [readability/naming] + +/**\ingroup EL_mem_getLength +* \~english @par Brief +* Get length of function region according to mem_id. +* \~english @param [in] mem_id +* int - memory id +* \~english @par +* Defined memory id as follows. +* \~english @code +* enum { +* // SYS +* EL_MEM_ID_SYS_ALL = 0x0001, // all SYS region +* EL_MEM_ID_SYS_BOOT, // particular: BOOT region +* // COM +* EL_MEM_ID_COM_ALL = 0x2001, // all COMMUNICATION region +* EL_MEM_ID_COM_SH4A, // particular: SH4A abnornal observation +* // NAVI +* EL_MEM_ID_NAVI_ALL = 0x3001, // NAVI region +* EL_MEM_ID_NAVI_LOG, // particular: NAVI(AW) LOG region +* // SH4A +* EL_MEM_ID_SH4A_ALL = 0x4001, // SH4A region +* EL_MEM_ID_SH4A_SHM, // particular: SH4A SH share memory region +* // PRAMFS NOTE:ROM only +* EL_MEM_ID_PRAMFS_ALL = 0x5001, // all PRAMFS region +* // STARTUPBGM +* EL_MEM_ID_STARTUPBGM_ALL = 0x6001, // all STARTUPBGM region +* // NAVI (Image Recognition) +* EL_MEM_ID_NAVI_IR_ALL = 0x7001, // all NAVI picture recognition region +* }; +* @endcode +* \~english @retval length Success +* \~english @retval 0 Error +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - Parameter mem_id is not defined.[0] +* - syscall error(open(), ioctl()).[0] +* \~english @par Detail +* - Get length of function region according to mem_id. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see none +*/ +size_t EL_mem_getLength(int mem_id); // NOLINT [readability/naming] + +/**\ingroup EL_mem_exram_mmap_simple +* \~english @par Brief +* Map device file to memory.(simple) +* \~english @param [in] mem_id +* int - memory id +* \~english @param [in] prot +* int - Linux standard (same to mmap() of /dev/mem) +* \~english @param [in] flags +* int - Linux standard (same to mmap() of /dev/mem) +* \~english @param [in] cache_flag +* int - cache flag valid/invalid +* \~english @par +* Defined memory id as follows. +* \~english @code +* enum { +* // SYS +* EL_MEM_ID_SYS_ALL = 0x0001, // all SYS region +* EL_MEM_ID_SYS_BOOT, // particular: BOOT region +* // COM +* EL_MEM_ID_COM_ALL = 0x2001, // all COMMUNICATION region +* EL_MEM_ID_COM_SH4A, // particular: SH4A abnornal observation +* // NAVI +* EL_MEM_ID_NAVI_ALL = 0x3001, // NAVI region +* EL_MEM_ID_NAVI_LOG, // particular: NAVI(AW) LOG region +* // SH4A +* EL_MEM_ID_SH4A_ALL = 0x4001, // SH4A region +* EL_MEM_ID_SH4A_SHM, // particular: SH4A SH share memory region +* // PRAMFS NOTE:ROM only +* EL_MEM_ID_PRAMFS_ALL = 0x5001, // all PRAMFS region +* // STARTUPBGM +* EL_MEM_ID_STARTUPBGM_ALL = 0x6001, // all STARTUPBGM region +* // NAVI (Image Recognition) +* EL_MEM_ID_NAVI_IR_ALL = 0x7001, // all NAVI picture recognition region +* }; +* @endcode +* \~english @par +* Cache flag as follows. +* \~english @code +* #define EL_MEM_CACHE_VALID 1 // valid cache +* #define EL_MEM_CACHE_INVALID 0 // invalid cache +* @endcode +* \~english @retval address Success +* \~english @retval -1 Error +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - Parameter mem_id is not defined.[-1] +* - Open device file failed.[-1] +* - Map device file to memory error.[-1] +* \~english @par Detail +* - Get type, offset and length from internal table specified by mem_id, then\n +* call \ref EL_mem_exram_mmap. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see EL_mem_getLength, EL_mem_exram_mmap, EL_mem_exram_munmap +*/ +void *EL_mem_exram_mmap_simple(int mem_id , int prot, int flags , int cache_flag); // NOLINT [readability/naming] + +/**\ingroup EL_mem_exram_mmap +* \~english @par Brief +* Map device file to memory. +* \~english @param [in] type +* int - memory type +* \~english @param [in] offset +* off_t - offset(From 0\ref EL_mem_getOffset) +* \~english @param [in] length +* size_t - length(From 1\ref EL_mem_getLength) +* \~english @param [in] prot +* int - Linux standard (same to mmap() of /dev/mem) +* \~english @param [in] flags +* int - Linux standard (same to mmap() of /dev/mem) +* \~english @param [in] cache_flag +* int - cache flag valid/invalid +* \~english @par +* Defined memory type as follows. +* \~english @code +* enum { +* EL_MEM_TYPE_REGION_SYS, // SYS +* EL_MEM_TYPE_REGION_COM, // COMMUNICATION +* EL_MEM_TYPE_REGION_NAVI, // NAVI +* EL_MEM_TYPE_REGION_SH4A, // SH4A +* EL_MEM_TYPE_REGION_PRAMFS, // PRAMFS +* EL_MEM_TYPE_REGION_STARTUPBGM, // STARTUPBGM +* EL_MEM_TYPE_REGION_NAVI_IR, // NAVI IMAGE +* }; +* @endcode +* \~english @par +* Cache flag as follows. +* \~english @code +* #define EL_MEM_CACHE_VALID 1 // valid cache +* #define EL_MEM_CACHE_INVALID 0 // invalid cache +* @endcode +* \~english @retval address Success +* \~english @retval -1 Error +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - Open device file failed.[-1] +* - Map device file to memory error.[-1] +* \~english @par Detail +* - Access device file specified by memory type, map function region to user space. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see EL_mem_exram_munmap +*/ +void *EL_mem_exram_mmap(int type, off_t offset , size_t length , int prot, int flags , int cache_flag); // NOLINT [readability/naming] + +/**\ingroup EL_mem_exram_munmap +* \~english @par Brief +* Unmap device file from memory. +* \~english @param [in] addr +* void * - address +* \~english @param [in] length +* size_t - size (1 ~ \ref EL_mem_getLength) +* \~english @retval 0 Success +* \~english @retval -1 Error:Set errno according to error type when error occurs. +* \~english @par Prerequisite +* - Map device file to memory(\ref EL_mem_exram_mmap, +* \ref EL_mem_exram_mmap_simple). +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - Unmap device file from memory error.[-1] +* \~english @par Detail +* - Unmap specified address.Error occurs when refer to this memory after unmap. +* - Automatic unmap when process ends. +* - The memory will not be unmap even the file descriptor is closed. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see EL_mem_exram_mmap, EL_mem_exram_mmap_simple +*/ +int EL_mem_exram_munmap(void *addr, size_t length); // NOLINT [readability/naming] + +/**\ingroup EL_mem_getPhysicalAddress +* \~english @par Brief +* Get physical address. +* \~english @param [in] mem_id +* int - memory id +* \~english @par +* Defined memory id as follows. +* \~english @code +* enum { +* // SYS +* EL_MEM_ID_SYS_ALL = 0x0001, // all SYS region +* EL_MEM_ID_SYS_BOOT, // particular: BOOT region +* // COM +* EL_MEM_ID_COM_ALL = 0x2001, // all COMMUNICATION region +* EL_MEM_ID_COM_SH4A, // particular: SH4A abnornal observation +* // NAVI +* EL_MEM_ID_NAVI_ALL = 0x3001, // NAVI region +* EL_MEM_ID_NAVI_LOG, // particular: NAVI(AW) LOG region +* // SH4A +* EL_MEM_ID_SH4A_ALL = 0x4001, // SH4A region +* EL_MEM_ID_SH4A_SHM, // particular: SH4A SH share memory region +* // PRAMFS NOTE:ROM only +* EL_MEM_ID_PRAMFS_ALL = 0x5001, // all PRAMFS region +* // STARTUPBGM +* EL_MEM_ID_STARTUPBGM_ALL = 0x6001, // all STARTUPBGM region +* // NAVI (Image Recognition) +* EL_MEM_ID_NAVI_IR_ALL = 0x7001, // all NAVI picture recognition region +* }; +* @endcode +* \~english @retval physical address Success +* \~english @retval 0 Error: Failed to open device file or get physical address(ioctl) +* \~english @retval -1 Error: Parameter mem_id is not defined. +* \~english @par Prerequisite +* - None. +* \~english @par Change of internal state +* - Change of internal state according to the API does not occur. +* \~english @par Conditions of processing failure +* - Parameter mem_id is not defined.[-1] +* - Get physical address error.[0] +* \~english @par Detail +* - Get physical address from dummy-memory driver according to device file specified by mem_id. +* - Return the sum value of physical address and offset specified by mem_id. +* \~english @par Classification +* Public +* \~english @par Type +* Sync +* \~english @see none +*/ +u_int64_t EL_mem_getPhysicalAddress(int mem_id); // NOLINT [readability/naming] + +#ifdef __cplusplus +} +#endif // __cplusplus + +/** @}*/ // end of memory_gpio_access_library +/** @}*/ // end of native_service +/** @}*/ // end of BaseSystem +#endif // MEMORY_GPIO_ACCESS_LIBRARY_CLIENT_INCLUDE_NATIVE_SERVICE_EL_MEM_H_ |