diff options
Diffstat (limited to 'interface_unified/library/include/system_service/ss_sm_client_if.h')
| -rw-r--r-- | interface_unified/library/include/system_service/ss_sm_client_if.h | 291 |
1 files changed, 1 insertions, 290 deletions
diff --git a/interface_unified/library/include/system_service/ss_sm_client_if.h b/interface_unified/library/include/system_service/ss_sm_client_if.h index 44fa6509..70b9425f 100644 --- a/interface_unified/library/include/system_service/ss_sm_client_if.h +++ b/interface_unified/library/include/system_service/ss_sm_client_if.h @@ -1,5 +1,5 @@ /* - * @copyright Copyright (c) 2016-2019 TOYOTA MOTOR CORPORATION. + * @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. @@ -77,76 +77,6 @@ extern EFrameworkunifiedStatus RegisterSMSessionAckCallback(EFrameworkunifiedStatus (*CallbackPtr)(HANDLE)); ///////////////////////////////////////////////////////////////////////////////////// -/// \ingroup SendBootModeSetRequestToSystemManager -/// \~english @par Summary -/// API to record the mode of the next boot in a non-volatile area. -/// \~english @param [in] hostBootMode -/// ESMBootModeInfo - BOOT mode information -/// \~english @par -/// - e_SS_SM_BOOT_MODE_APPLICATION : Normal start -/// - e_SS_SM_BOOT_MODE_PROGRAMMING : Version up start -/// \~english @retval eFrameworkunifiedStatusOK Success -/// \~english @retval eFrameworkunifiedStatusInvldParam Invalid parameter -/// \~english @retval eFrameworkunifiedStatusNullPointer Invalid pointer -/// \~english @retval eFrameworkunifiedStatusInvldHandle Invalid handle -/// \~english @retval eFrameworkunifiedStatusInvldHndlType Invalid type of handle -/// \~english @retval eFrameworkunifiedStatusMsgQFull Message queue is full -/// \~english @retval eFrameworkunifiedStatusErrNoEBADF Invalid File-Descriptor -/// \~english @retval eFrameworkunifiedStatusErrNoEINTR An interrupt is generated by the system call (signal) -/// \~english @retval eFrameworkunifiedStatusInvldBufSize Invalid buffer-size -/// \~english @retval eFrameworkunifiedStatusFail Some sort of error occurred -/// \~english @retval eFrameworkunifiedStatusErrOther Other error(It failed to open/allocation of shared memory) -/// \~english @par Preconditions -/// - Dispatcher for the System Manager is generated, and Availability of the service is TRUE. -/// \~english @par Change of the internal state -/// - The internal state is not changed. -/// \~english @par Causes of failures -/// - Specified BOOT mode information is invalid(In the case of value which does not correspond to enum -/// ESMBootModeInfo). [eFrameworkunifiedStatusInvldParam] -/// - System Manager of the session does not exist. [eFrameworkunifiedStatusNullPointer] -/// - System Manager handle for the session is NULL. [eFrameworkunifiedStatusInvldHandle] -/// - System Manager handle type for the session is not a transmission type. [eFrameworkunifiedStatusInvldHndlType] -/// - System Manager message queue for the session is full. [eFrameworkunifiedStatusMsgQFull] -/// - Transmission for the file descriptor of System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusErrNoEBADF] -/// - Place to interrupt by the system call (signal) has occurred during the transmission of the System Manager -/// message for the session. [eFrameworkunifiedStatusErrNoEINTR] -/// - Size of the transmission buffer of the System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusInvldBufSize] -/// - Any error has occurred at the time of transmission of the System Manager message for the session. -/// [eFrameworkunifiedStatusFail] -/// - Transmission of System Manager message for the session fails to shared memory access. [eFrameworkunifiedStatusErrOther] -/// \~english @par Classification -/// Public -/// \~english @par Type -/// Method only -/// \~english @par Detail -/// This function is called to set boot mode information in System Manager.\n -/// To set the next time BOOT mode, in the Notification name of NTFY_SSHUBootModes, broadcast to Subscribers.\n -/// Message specification of asynchronous response is sent to the caller.as follows: -/// - Command:\ref SS_SM_BOOT_MODE_SET_RESP -/// - Message Data:\ref TSystemManagerBootModeRequestResponse -/// \~english @code -/// typedef struct T_SystemManagerBootModeRequestResponse -/// { -/// ESMBootModeInfo hostBootMode; -/// EFrameworkunifiedStatus eFrameworkunifiedStatus; -/// }TSystemManagerBootModeRequestResponse; -/// #define NTFY_SSHUBootModes "SS_SysManager/HeadUnitBootModes" -/// @endcode -/// \~english @par -/// hostBootMode:BOOT mode -/// - e_SS_SM_BOOT_MODE_APPLICATION: Normal start -/// - e_SS_SM_BOOT_MODE_PROGRAMMING: Version up start -/// \~english @par -/// eFrameworkunifiedStatus:Result -/// - eFrameworkunifiedStatusOK:Success -/// - Except eFrameworkunifiedStatusOK:Fail -/// \~english @see None -//////////////////////////////////////////////////////////////////////////////////// -extern EFrameworkunifiedStatus SendBootModeSetRequestToSystemManager(ESMBootModeInfo hostBootMode); - -///////////////////////////////////////////////////////////////////////////////////// /// \ingroup SetDataResetModeToSystemManager /// \~english @par Summary /// API to record the data reset mode of the next boot in a non-volatile area. @@ -329,174 +259,6 @@ extern EFrameworkunifiedStatus SetProgUpdateStateToSystemManager(SMProgUpdateSta extern EFrameworkunifiedStatus SendCpuResetRequestToSystemManager(ESMCpuResetReason l_eCpuResetReason, std::string f_messageStr = "", std::string f_suffixStr = ""); -///////////////////////////////////////////////////////////////////////////////////// -/// \ingroup SetBootLoaderInfoRequestToSystemManager -/// \~english @par Summary -/// API to perform a write request to the specified field of shared memory with BootLoader. -/// \~english @param [in] f_type -/// ESMBootInfoType - Configuration information type -/// \~english @param [in] f_value -/// UI_32 - Set value -/// \~english @par -/// enum ESMBootInfoType Variable -/// - e_SS_SM_BOOT_INFO_MDUPDATE : Writing to LBM_RAM_t.mdUpdate -/// - e_SS_SM_BOOT_INFO_SDUPDATE : Writing to LBM_RAM_t.sdUpdate -/// \~english @retval eFrameworkunifiedStatusOK Success -/// \~english @retval eFrameworkunifiedStatusInvldParam Invalid parameter -/// \~english @retval eFrameworkunifiedStatusNullPointer Invalid pointer -/// \~english @retval eFrameworkunifiedStatusInvldHandle Invalid handle -/// \~english @retval eFrameworkunifiedStatusInvldHndlType Invalid type of handle -/// \~english @retval eFrameworkunifiedStatusMsgQFull Message queue is full -/// \~english @retval eFrameworkunifiedStatusErrNoEBADF Invalid File-Descriptor -/// \~english @retval eFrameworkunifiedStatusErrNoEINTR An interrupt is generated by the system call (signal) -/// \~english @retval eFrameworkunifiedStatusInvldBufSize Invalid buffer-size -/// \~english @retval eFrameworkunifiedStatusBadConnection Socket connection error -/// \~english @retval eFrameworkunifiedStatusFail Some sort of error occurred -/// \~english @retval eFrameworkunifiedStatusErrOther Other error(It failed to open/allocation of shared memory) -/// \~english @par Preconditions -/// - Dispatcher for the System Manager is generated, and Availability of the service is TRUE. -/// \~english @par Change of the internal state -/// - The internal state is not changed. -/// \~english @par Causes of failures -/// - Information type is illegal (in the case of a value that does not correspond to the enum ESMBootInfoType). -/// [eFrameworkunifiedStatusInvldParam] -/// - System Manager of the session does not exist. [eFrameworkunifiedStatusNullPointer] -/// - System Manager handle for the session is NULL. [eFrameworkunifiedStatusInvldHandle] -/// - System Manager handle type for the session is not a send and receive type. [eFrameworkunifiedStatusInvldHndlType] -/// - System Manager message queue for the session is full. [eFrameworkunifiedStatusMsgQFull] -/// - Send and receive for the file descriptor of System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusErrNoEBADF] -/// - Place to interrupt by the system call (signal) has occurred during the send and receive of the System -/// Manager message for the session. [eFrameworkunifiedStatusErrNoEINTR] -/// - Size of the send and receive buffer of the System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusInvldBufSize] -/// - Send and receive and reception of System Manager message for the session fails to socket connection. -/// [eFrameworkunifiedStatusBadConnection] -/// - Any error has occurred at the time of send and receive of the System Manager message for the session. -/// [eFrameworkunifiedStatusFail] -/// - Send and receive of System Manager message for the session fails to shared memory access. -/// [eFrameworkunifiedStatusErrOther] -/// \~english @par Classification -/// Public -/// \~english @par Type -/// Sync only(None communication) -/// \~english @par Detail -/// For the specified field in f_type, writing of the value of f_value.\n -/// See the include/cls/ss_boot_map.h for the meaning of the value of each field and f_value. -/// \~english @see -/// None -//////////////////////////////////////////////////////////////////////////////////// -extern EFrameworkunifiedStatus SetBootLoaderInfoRequestToSystemManager(ESMBootInfoType f_type, UI_32 f_value); - - -///////////////////////////////////////////////////////////////////////////////////// -/// \ingroup GetBootLoaderInfoRequestToSystemManager -/// \~english @par Summary -/// This function is called to get Boot-Loader Information. -/// \~english @param [out] p_info -/// void* - pointer for Boot-Loader Information -/// \~english @retval eFrameworkunifiedStatusOK Success -/// \~english @retval eFrameworkunifiedStatusNullPointer Invalid pointer -/// \~english @retval eFrameworkunifiedStatusInvldHandle Invalid handle -/// \~english @retval eFrameworkunifiedStatusInvldHndlType Invalid type of handle -/// \~english @retval eFrameworkunifiedStatusMsgQFull Message queue is full -/// \~english @retval eFrameworkunifiedStatusErrNoEBADF Invalid File-Descriptor -/// \~english @retval eFrameworkunifiedStatusErrNoEINTR An interrupt is generated by the system call (signal) -/// \~english @retval eFrameworkunifiedStatusInvldBufSize Invalid buffer-size -/// \~english @retval eFrameworkunifiedStatusBadConnection Socket connection error -/// \~english @retval eFrameworkunifiedStatusFail Some sort of error occurred -/// \~english @retval eFrameworkunifiedStatusErrOther Other error(It failed to open/allocation of shared memory) -/// \~english @par Preconditions -/// - Dispatcher for the System Manager is generated, and Availability of the service is TRUE. -/// \~english @par Change of the internal state -/// - The internal state is not changed. -/// \~english @par Causes of failures -/// - System Manager of the session does not exist. [eFrameworkunifiedStatusNullPointer] -/// - System Manager handle for the session is NULL. [eFrameworkunifiedStatusInvldHandle] -/// - System Manager handle type for the session is not a send and receive type. [eFrameworkunifiedStatusInvldHndlType] -/// - System Manager message queue for the session is full. [eFrameworkunifiedStatusMsgQFull] -/// - Send and receive for the file descriptor of System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusErrNoEBADF] -/// - Place to interrupt by the system call (signal) has occurred during the send and receive of the System -/// Manager message for the session. [eFrameworkunifiedStatusErrNoEINTR] -/// - Size of the send and receive buffer of the System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusInvldBufSize] -/// - Send and receive and reception of System Manager message for the session fails to socket connection. -/// [eFrameworkunifiedStatusBadConnection] -/// - Any error has occurred at the time of send and receive of the System Manager message for the session. -/// [eFrameworkunifiedStatusFail] -/// - Send and receive of System Manager message for the session fails to shared memory access. -/// [eFrameworkunifiedStatusErrOther] -/// \~english @par Classification -/// Public -/// \~english @par Type -/// Sync only(None communication) -/// \~english @par Detail -/// Get the Boot-Loader Information. -/// \~english @see -/// None -//////////////////////////////////////////////////////////////////////////////////// -extern EFrameworkunifiedStatus GetBootLoaderInfoRequestToSystemManager(void *p_info); - - -///////////////////////////////////////////////////////////////////////////////////// -/// \ingroup SetWakeupOrderToSystemManager -/// \~english @par Summary -/// API to save the boot order. -/// \~english @param [in] f_orderName -/// std::string - Boot order defined name -/// \~english @par -/// - Boot order defined name, it is 0-32byte. -/// \~english @retval eFrameworkunifiedStatusOK Success -/// \~english @retval eFrameworkunifiedStatusInvldParam Invalid parameter -/// \~english @retval eFrameworkunifiedStatusNullPointer Invalid pointer -/// \~english @retval eFrameworkunifiedStatusInvldHandle Invalid handle -/// \~english @retval eFrameworkunifiedStatusInvldHndlType Invalid type of handle -/// \~english @retval eFrameworkunifiedStatusMsgQFull Message queue is full -/// \~english @retval eFrameworkunifiedStatusErrNoEBADF Invalid File-Descriptor -/// \~english @retval eFrameworkunifiedStatusErrNoEINTR An interrupt is generated by the system call (signal) -/// \~english @retval eFrameworkunifiedStatusInvldBufSize Invalid buffer-size -/// \~english @retval eFrameworkunifiedStatusBadConnection Socket connection error -/// \~english @retval eFrameworkunifiedStatusFail Some sort of error occurred -/// \~english @retval eFrameworkunifiedStatusErrOther Other error(It failed to open/allocation of shared memory) -/// \~english @par Preconditions -/// - Dispatcher for the System Manager is generated, and Availability of the service is TRUE. -/// \~english @par Change of the internal state -/// - The internal state is not changed. -/// \~english @par Causes of failures -/// - Start-up sequence defined name (f_orderName) exceeds the 32Byte. [eFrameworkunifiedStatusInvldParam] -/// - System Manager of the session does not exist. [eFrameworkunifiedStatusNullPointer] -/// - System Manager handle for the session is NULL. [eFrameworkunifiedStatusInvldHandle] -/// - System Manager handle type for the session is not a send and receive type. [eFrameworkunifiedStatusInvldHndlType] -/// - System Manager message queue for the session is full. [eFrameworkunifiedStatusMsgQFull] -/// - Send and receive for the file descriptor of System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusErrNoEBADF] -/// - Place to interrupt by the system call (signal) has occurred during the send and receive of the System -/// Manager message for the session. [eFrameworkunifiedStatusErrNoEINTR] -/// - Size of the send and receive buffer of the System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusInvldBufSize] -/// - Send and receive and reception of System Manager message for the session fails to socket connection. -/// [eFrameworkunifiedStatusBadConnection] -/// - Any error has occurred at the time of send and receive of the System Manager message for the session. -/// [eFrameworkunifiedStatusFail] -/// - Send and receive of System Manager message for the session fails to shared memory access. -/// [eFrameworkunifiedStatusErrOther] -/// \~english @par Classification -/// Public -/// \~english @par Type -/// Sync only(None communication) -/// \~english @par Detail -/// It recorded the specified boot order in the f_orderName, the function return.\n -/// The value specified in the f_orderName able to refer to the include/cls/agl_wakeup_order.h .\n -/// If you specify a string of Length = 0 to f_orderName, discard the boot order. (= The default boot order) \n -/// In the order in which they are defined in the Order Configuration of the boot sequence specified in this \n -/// API at system startup do the start-up of the Group. \n -/// Boot sequence, discarded at the time of destruction of the completion of start-up time and the DRAM backup \n -/// of all services. -/// \~english @see None -//////////////////////////////////////////////////////////////////////////////////// -extern EFrameworkunifiedStatus SetWakeupOrderToSystemManager(std::string f_orderName); - //////////////////////////////////////////////////////////////////////////////////////////// /// \ingroup SetNextWakeupTypeToSystemManager /// \~english @par Summary @@ -525,57 +287,6 @@ extern EFrameworkunifiedStatus SetWakeupOrderToSystemManager(std::string f_order //////////////////////////////////////////////////////////////////////////////////////////// extern EFrameworkunifiedStatus SetNextWakeupTypeToSystemManager(ESMNextWakeupType f_wakeupType); -///////////////////////////////////////////////////////////////////////////////////// -/// \ingroup SendVarCodeDataToSystemManager -/// \~english @par Summary -/// In debugging, API to log the character information of variable code. -/// \~english @param [in] f_uiLength -/// UI_32 - Data length of f_data -/// \~english @param [in] f_data -/// void - Variable code(char type) -/// \~english @retval eFrameworkunifiedStatusOK Success -/// \~english @retval eFrameworkunifiedStatusInvldBuf Invalid buffer -/// \~english @retval eFrameworkunifiedStatusNullPointer Invalid pointer -/// \~english @retval eFrameworkunifiedStatusInvldHandle Invalid handle -/// \~english @retval eFrameworkunifiedStatusInvldHndlType Invalid type of handle -/// \~english @retval eFrameworkunifiedStatusMsgQFull Message queue is full -/// \~english @retval eFrameworkunifiedStatusErrNoEBADF Invalid File-Descriptor -/// \~english @retval eFrameworkunifiedStatusErrNoEINTR An interrupt is generated by the system call (signal) -/// \~english @retval eFrameworkunifiedStatusInvldBufSize Invalid buffer-size -/// \~english @retval eFrameworkunifiedStatusFail Some sort of error occurred -/// \~english @retval eFrameworkunifiedStatusErrOther Other error(It failed to open/allocation of shared memory) -/// \~english @par Preconditions -/// - Dispatcher for the System Manager is generated, and Availability of the service is TRUE. -/// \~english @par Change of the internal state -/// - The internal state is not changed. -/// \~english @par Causes of failures -/// - Variable code f_data is NULL. [eFrameworkunifiedStatusInvldBuf] -/// - System Manager of the session does not exist. [eFrameworkunifiedStatusNullPointer] -/// - System Manager handle for the session is NULL. [eFrameworkunifiedStatusInvldHandle] -/// - System Manager handle type for the session is not a transmission type. [eFrameworkunifiedStatusInvldHndlType] -/// - System Manager message queue for the session is full. [eFrameworkunifiedStatusMsgQFull] -/// - Transmission for the file descriptor of System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusErrNoEBADF] -/// - Place to interrupt by the system call (signal) has occurred during the transmission of the System Manager -/// message for the session. [eFrameworkunifiedStatusErrNoEINTR] -/// - Size of the transmission buffer of the System Manager message for the session is invalid. -/// [eFrameworkunifiedStatusInvldBufSize] -/// - Any error has occurred at the time of transmission of the System Manager message for the session. -/// [eFrameworkunifiedStatusFail] -/// - Transmission of System Manager message for the session fails to shared memory access. [eFrameworkunifiedStatusErrOther] -/// \~english @par Classification -/// Public -/// \~english @par Type -/// Fire and Forget only -/// \~english @par Detail -/// The character string information specified in f_data upon LOG saving, -/// and outputs the system information LOG. -/// \~english @see SendClearLogsRequestToSystemManager -//////////////////////////////////////////////////////////////////////////////////// -extern EFrameworkunifiedStatus SendVarCodeDataToSystemManager(UI_32 f_uiLength, - void *f_data); - - ///////////////////////////////////////////////////////////////////////////////////// /// \ingroup Set_UseStopCompleteNotificationVsInterfaceunifiedOnStopFnc_StateVar |