2 * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * @file ss_string_maps.h
19 * @brief \~english This file supports the a generic std::map<std::string> wrapper.
21 /** @addtogroup BaseSystem
24 /** @addtogroup system_service
28 /** @addtogroup interface_unified
29 * @ingroup system_service
32 #ifndef SS_STRING_MAPS_H_ // NOLINT (build/header_guard)
33 #define SS_STRING_MAPS_H_
35 #include "system_service/ss_power_service.h"
36 #include "system_service/ss_system_manager_if.h"
37 #include "system_service/ss_system_manager_protocol.h"
39 /////////////////////////////////////////////////////////////////////////////////////
41 /// \~english @par Summary
42 /// change member from BOOL type to string
43 /// \~english @param [in] f_enum
44 /// BOOL - the member what will convert farm BOOL type to string type
47 /// #define TRUE (1==1)
48 /// #define true (1==1)
49 /// #define FALSE (0==1)
51 /// \~english @retval SS_String
52 /// \~english @par Preconditions
54 /// \~english @par Change of the internal state
55 /// - The internal state is not changed.
56 /// \~english @par Causes of failures
58 /// \~english @par Classification
60 /// \~english @par Type
62 /// \~english @par Detail
63 /// change member from BOOL type to string. \n
65 ////////////////////////////////////////////////////////////////////////////////////
66 extern SS_String GetStr(BOOL f_enum);
68 /////////////////////////////////////////////////////////////////////////////////////
70 /// \~english @par Summary
71 /// change member from EErrorEventType type to string
72 /// \~english @param [in] f_enum
73 /// EErrorEventType - the member what will convert farm EErrorEventType type to string type.error event type.
75 /// enum EErrorEventType {
76 /// eErrorEventTypeProcessCrash = 0,
77 /// eErrorEventTypeHeartBeatFailure,
78 /// eErrorEventTypeSystemLowMemory,
79 /// eErrorEventTypeReserved1, // Formerly SS_SM_EVENT_ERROR_HIGH_CPU_LOAD, now HMI enum place holder.
80 /// eErrorEventTypeUserInvokedUserForceReset,
81 /// eErrorEventTypeReserved2,
82 /// eErrorEventTypeReserved3,
83 /// eErrorEventTypeUserInvokedCollectAllLogs,
84 /// eErrorEventTypeBootMicroReset,
85 /// eErrorEventTypeProcessExit,
86 /// eErrorEventTypeUserInvokedCollectScreenShot,
87 /// eErrorEventTypeUserInvokedCollectInterfaceunifiedLogs,
88 /// eErrorEventTypeEelExport,
89 /// eErrorEventTypeInterfaceunifiedEmmcLogs,
90 /// eErrorEventTypeDiagEvent,
91 /// eErrorEventTypeCanEvent,
92 /// eErrorEventTypeDtcEvent,
93 /// eErrorEventTypeModConnFailed,
94 /// eErrorEventTypeStartRespFailed,
95 /// eErrorEventTypeUserInvokedCollectDevLogs,
96 /// eErrorEventTypeModuleInvokedResetRequest,
97 /// eErrorEventTypeModuleInvokedCollectDebugLogs,
98 /// eErrorEventTypeUserInvokedClearLogs,
99 /// eErrorEventTypeUserInvokedCollectNaviLog,
100 /// eErrorEventTypeGroupRelaunch,
101 /// eErrorEventTypeMaxValue
104 /// \~english @retval SS_String
105 /// \~english @par Preconditions
107 /// \~english @par Change of the internal state
108 /// - The internal state is not changed.
109 /// \~english @par Causes of failures
111 /// \~english @par Classification
113 /// \~english @par Type
115 /// \~english @par Detail
116 /// change member from EErrorEventType type to string. \n
118 ////////////////////////////////////////////////////////////////////////////////////
119 extern SS_String GetStr(EErrorEventType f_enum);
121 /////////////////////////////////////////////////////////////////////////////////////
123 /// \~english @par Summary
124 /// change member from EFrameworkunifiedSystemError type to string
125 /// \~english @param [in] f_enum
126 /// EFrameworkunifiedSystemError - the member what will convert farm EFrameworkunifiedSystemError type to string type.The type of system
129 /// typedef enum _EFrameworkunifiedSystemError {
130 /// eFrameworkunifiedSystemErrorNone = 0,
131 /// eFrameworkunifiedDSPHardwareReset = 1
132 /// } EFrameworkunifiedSystemError;
134 /// \~english @retval SS_String
135 /// \~english @par Preconditions
137 /// \~english @par Change of the internal state
138 /// - The internal state is not changed.
139 /// \~english @par Causes of failures
141 /// \~english @par Classification
143 /// \~english @par Type
145 /// \~english @par Detail
146 /// change member from EFrameworkunifiedSystemError type to string. \n
148 ////////////////////////////////////////////////////////////////////////////////////
149 extern SS_String GetStr(EFrameworkunifiedSystemError f_enum);
151 /////////////////////////////////////////////////////////////////////////////////////
153 /// \~english @par Summary
154 /// change member from EPWR_LHC_TYPE type to string
155 /// \~english @param [in] f_enum
156 /// EPWR_LHC_TYPE - the member what will convert farm EPWR_LHC_TYPE type to string type.Limp home cutoff
160 /// epslhcINVALID = 0xFF,
161 /// epslhcDISABLED = 0x00,
162 /// epslhcENABLED = 0x01
163 /// } ePwrServiceLHCType, EPWR_LHC_TYPE;
165 /// \~english @retval SS_String
166 /// \~english @par Preconditions
168 /// \~english @par Change of the internal state
169 /// - The internal state is not changed.
170 /// \~english @par Causes of failures
172 /// \~english @par Classification
174 /// \~english @par Type
176 /// \~english @par Detail
177 /// change member from EPWR_LHC_TYPE type to string. \n
179 ////////////////////////////////////////////////////////////////////////////////////
180 extern SS_String GetStr(EPWR_LHC_TYPE f_enum);
182 /////////////////////////////////////////////////////////////////////////////////////
184 /// \~english @par Summary
185 /// change member from EPWR_PROD_MODE_TYPE type to string
186 /// \~english @param [in] f_enum
187 /// EPWR_PROD_MODE_TYPE - the member what will convert farm EPWR_PROD_MODE_TYPE type to string type.The type of
188 /// production mode protocol.
191 /// epspmINVALID = 0xFF,
192 /// epspmDISABLED = 0x00,
193 /// epspmENABLED = 0x01
194 /// } ePwrServiceProdModeType, EPWR_PROD_MODE_TYPE;
196 /// \~english @retval SS_String
197 /// \~english @par Preconditions
199 /// \~english @par Change of the internal state
200 /// - The internal state is not changed.
201 /// \~english @par Causes of failures
203 /// \~english @par Classification
205 /// \~english @par Type
207 /// \~english @par Detail
208 /// change member from EPWR_PROD_MODE_TYPE type to string. \n
210 ////////////////////////////////////////////////////////////////////////////////////
211 extern SS_String GetStr(EPWR_PROD_MODE_TYPE f_enum);
213 /////////////////////////////////////////////////////////////////////////////////////
215 /// \~english @par Summary
216 /// change member from EPWR_SC_COLD_START_REQ_TYPE type to string
217 /// \~english @param [in] f_enum
218 /// EPWR_SC_COLD_START_REQ_TYPE - the member what will convert farm EFrameworkunifiedSystemError type to string type.The type
222 /// epsscrtINVALID = 0xFF,
223 /// epsscrtNOT_REQUIRED = 0x00,
224 /// epsscrtREQUIRED = 0x01
225 /// } EPWR_SC_COLD_START_REQ_TYPE;
227 /// \~english @retval SS_String
228 /// \~english @par Preconditions
230 /// \~english @par Change of the internal state
231 /// - The internal state is not changed.
232 /// \~english @par Causes of failures
234 /// \~english @par Classification
236 /// \~english @par Type
238 /// \~english @par Detail
239 /// change member from EPWR_SC_COLD_START_REQ_TYPE type to string. \n
241 ////////////////////////////////////////////////////////////////////////////////////
242 extern SS_String GetStr(EPWR_SC_COLD_START_REQ_TYPE f_enum);
244 /////////////////////////////////////////////////////////////////////////////////////
246 /// \~english @par Summary
247 /// change member from EPWR_SC__CWORD56__BOOT_MODE_TYPE type to string
248 /// \~english @param [in] f_enum
249 /// EPWR_SC__CWORD56__BOOT_MODE_TYPE - the member what will convert farm EPWR_SC__CWORD56__BOOT_MODE_TYPE type to string
250 /// type.The type of startup confirmation.
253 /// eps_CWORD56_bmINVALID = 0xFF,
254 /// eps_CWORD56_bmAPPLICATION_MODE = 0x00,
255 /// eps_CWORD56_bmPROGRAMMING_MODE = 0x08
256 /// } EPWR_SC__CWORD56__BOOT_MODE_TYPE;
258 /// \~english @retval SS_String
259 /// \~english @par Preconditions
261 /// \~english @par Change of the internal state
262 /// - The internal state is not changed.
263 /// \~english @par Causes of failures
265 /// \~english @par Classification
267 /// \~english @par Type
269 /// \~english @par Detail
270 /// change member from EPWR_SC__CWORD56__BOOT_MODE_TYPE type to string. \n
272 ////////////////////////////////////////////////////////////////////////////////////
273 extern SS_String GetStr(EPWR_SC__CWORD56__BOOT_MODE_TYPE f_enum);
275 /////////////////////////////////////////////////////////////////////////////////////
277 /// \~english @par Summary
278 /// change member from EPWR_SHUTDOWN_TRIGGER_TYPE type to string
279 /// \~english @param [in] f_enum
280 /// EPWR_SHUTDOWN_TRIGGER_TYPE - the member what will convert farm EPWR_SHUTDOWN_TRIGGER_TYPE type to string
281 /// type.The type of shutdown trigger.
284 /// epssdmsdtINVALID = 0xFF,
285 /// epssdmsdtTESTACC_OFF = 0x00,
286 /// epssdmsdtON_KEY = 0x01,
287 /// epssdmsdtIGN_LOCK = 0x02,
288 /// epssdmsdtPWR_SAVE = 0x03,
289 /// epssdmsdtTMP_STARTUP = 0x04,
290 /// epssdmsdtDIAG_DEACTIVATION = 0x05,
291 /// epssdmsdtABNORMAL_VOLTAGE = 0x06,
292 /// epssdmsdtABNORMAL_TEMP = 0x07,
293 /// epssdmsdtBATTERYCUTOFF = 0x08,
294 /// epssdmsdtLIMPHOME = 0x09,
295 /// epssdmsdtHU_CAN_ERROR = 0x0A,
296 /// epssdmsdtBODY_CAN_ERROR = 0x0B,
297 /// epssdmsdtTRANSPORT_MODE = 0x0C,
298 /// epssdmsdtPRODUCTION_MODE = 0x0D,
299 /// epssdmsdtIGN_OFF = 0x0E,
300 /// epssdmsdtGENERIC_ERROR_RESET = 0x0F,
301 /// epssdmsdtFATAL_ERROR_RESET = 0x10,
302 /// epssdmsdtUSER_DATA_RESET = 0x11,
303 /// epssdmsdtFACTORY_DATA_RESET = 0x12,
304 /// epssdmsdtFAST_SLEEP_MODE = 0x13,
305 /// epssdmsdtNORMAL_RESET = 0x14,
306 /// epssdmsdtPROGUPDATE_RESET = 0x15,
307 /// } ePowerSrvPwrShutdownTriggerType, EPWR_SHUTDOWN_TRIGGER_TYPE;
309 /// \~english @retval SS_String
310 /// \~english @par Preconditions
312 /// \~english @par Change of the internal state
313 /// - The internal state is not changed.
314 /// \~english @par Causes of failures
316 /// \~english @par Classification
318 /// \~english @par Type
320 /// \~english @par Detail
321 /// change member from EPWR_SHUTDOWN_TRIGGER_TYPE type to string. \n
323 ////////////////////////////////////////////////////////////////////////////////////
324 extern SS_String GetStr(EPWR_SHUTDOWN_TRIGGER_TYPE f_enum);
326 /////////////////////////////////////////////////////////////////////////////////////
328 /// \~english @par Summary
329 /// change member from EPWR_STARTUP_STAGE_TYPE type to string
330 /// \~english @param [in] f_enum
331 /// EPWR_STARTUP_STAGE_TYPE - the member what will convert farm EPWR_STARTUP_STAGE_TYPE type to string type.The
332 /// type of startup stage.
335 /// epssusfINVALID = 0xFF,
336 /// epssusSYSTEM_SERVICES_STARTED = 0x00,
337 /// epssusALL_SERVICES_LAUNCHED = 0x01
338 /// }ePowerSrvStartupStageType, EPWR_STARTUP_STAGE_TYPE;
340 /// \~english @retval SS_String
341 /// \~english @par Preconditions
343 /// \~english @par Change of the internal state
344 /// - The internal state is not changed.
345 /// \~english @par Causes of failures
347 /// \~english @par Classification
349 /// \~english @par Type
351 /// \~english @par Detail
352 /// change member from EPWR_STARTUP_STAGE_TYPE type to string. \n
354 ////////////////////////////////////////////////////////////////////////////////////
355 extern SS_String GetStr(EPWR_STARTUP_STAGE_TYPE f_enum);
357 /////////////////////////////////////////////////////////////////////////////////////
359 /// \~english @par Summary
360 /// change member from EPWR_SYSTEM_MODE_INFO type to string
361 /// \~english @param [in] f_enum
362 /// EPWR_SYSTEM_MODE_INFO - the member what will convert farm EPWR_SYSTEM_MODE_INFO type to string type.The type
363 /// of system mode info.
366 /// epssinfINVALID = 0xFF,
367 /// epssinfNORMAL = 0x00,
368 /// epssinfPROGRAMMING = 0x08,
369 /// }ePowerSrvSystemModeInfo, EPWR_SYSTEM_MODE_INFO;
371 /// \~english @retval SS_String
372 /// \~english @par Preconditions
374 /// \~english @par Change of the internal state
375 /// - The internal state is not changed.
376 /// \~english @par Causes of failures
378 /// \~english @par Classification
380 /// \~english @par Type
382 /// \~english @par Detail
383 /// change member from EPWR_SYSTEM_MODE_INFO type to string. \n
385 ////////////////////////////////////////////////////////////////////////////////////
386 extern SS_String GetStr(EPWR_SYSTEM_MODE_INFO f_enum);
388 /////////////////////////////////////////////////////////////////////////////////////
390 /// \~english @par Summary
391 /// change member from EPWR_TRANSPORT_MODE_TYPE type to string
392 /// \~english @param [in] f_enum
393 /// EPWR_TRANSPORT_MODE_TYPE - the member what will convert farm EPWR_TRANSPORT_MODE_TYPE type to string
394 /// type.The type of transport mode protocol.
397 /// epstmINVALID = 0xFF,
398 /// epstmDISABLED = 0x00,
399 /// epstmENABLED = 0x01
400 /// } ePwrServiceTransportModeType, EPWR_TRANSPORT_MODE_TYPE;
402 /// \~english @retval SS_String
403 /// \~english @par Preconditions
405 /// \~english @par Change of the internal state
406 /// - The internal state is not changed.
407 /// \~english @par Causes of failures
409 /// \~english @par Classification
411 /// \~english @par Type
413 /// \~english @par Detail
414 /// change member from EPWR_TRANSPORT_MODE_TYPE type to string. \n
416 ////////////////////////////////////////////////////////////////////////////////////
417 extern SS_String GetStr(EPWR_TRANSPORT_MODE_TYPE f_enum);
419 /////////////////////////////////////////////////////////////////////////////////////
421 /// \~english @par Summary
422 /// change member from \ref ePwrServiceUserModeChangeReasonType "EPWR_USER_MODE_CHANGE_REASON_TYPE" type to string
423 /// \~english @param [in] f_enum
424 /// \ref ePwrServiceUserModeChangeReasonType "EPWR_USER_MODE_CHANGE_REASON_TYPE" - the member what will convert farm \ref ePwrServiceUserModeChangeReasonType "EPWR_USER_MODE_CHANGE_REASON_TYPE" type
425 /// to string type.The type of user mode change reason.
426 /// \~english @retval SS_String
427 /// \~english @par Preconditions
429 /// \~english @par Change of the internal state
430 /// - The internal state is not changed.
431 /// \~english @par Causes of failures
433 /// \~english @par Classification
435 /// \~english @par Type
437 /// \~english @par Detail
438 /// change member from type \ref ePwrServiceUserModeChangeReasonType "EPWR_USER_MODE_CHANGE_REASON_TYPE" to string. \n
440 ////////////////////////////////////////////////////////////////////////////////////
441 extern SS_String GetStr(EPWR_USER_MODE_CHANGE_REASON_TYPE f_enum);
443 /////////////////////////////////////////////////////////////////////////////////////
445 /// \~english @par Summary
446 /// change member from EPWR_USER_MODE_TYPE type to string
447 /// \~english @param [in] f_enum
448 /// EPWR_USER_MODE_TYPE - the member what will convert farm EPWR_USER_MODE_TYPE type to string type.The type of
452 /// epsumINVALID = 0xFF,
455 /// } ePwrServiceUserModeType, EPWR_USER_MODE_TYPE;
457 /// \~english @retval SS_String
458 /// \~english @par Preconditions
460 /// \~english @par Change of the internal state
461 /// - The internal state is not changed.
462 /// \~english @par Causes of failures
464 /// \~english @par Classification
466 /// \~english @par Type
468 /// \~english @par Detail
469 /// change member from EPWR_USER_MODE_TYPE type to string. \n
471 ////////////////////////////////////////////////////////////////////////////////////
472 extern SS_String GetStr(EPWR_USER_MODE_TYPE f_enum);
474 /////////////////////////////////////////////////////////////////////////////////////
476 /// \~english @par Summary
477 /// change member from EPWR_WAKEUP_FACTOR_TYPE type to string
478 /// \~english @param [in] f_enum
479 /// EPWR_WAKEUP_FACTOR_TYPE - the member what will convert farm EPWR_WAKEUP_FACTOR_TYPE type to string type.The
480 /// type of startup reason.
483 /// epswfINVALID = 0xFF,
484 /// epswfTESTACC = 0x00,
485 /// epswfON_KEY = 0x01,
486 /// epswfIGN_ACC = 0x02,
487 /// epswfDR_OPEN_CLOSE = 0x03,
488 /// epswfDX_ACTIVATION = 0x04,
489 /// epswfPASS_ACTIVATION = 0x05,
490 /// epswfSPVACTIVATION = 0x06,
491 /// epswfUSER_DATA_RESET = 0x07
492 /// } ePowerSrvWakeupFactors, EPWR_WAKEUP_FACTOR_TYPE;
494 /// \~english @retval SS_String
495 /// \~english @par Preconditions
497 /// \~english @par Change of the internal state
498 /// - The internal state is not changed.
499 /// \~english @par Causes of failures
501 /// \~english @par Classification
503 /// \~english @par Type
505 /// \~english @par Detail
506 /// change member from EPWR_WAKEUP_FACTOR_TYPE type to string. \n
508 ////////////////////////////////////////////////////////////////////////////////////
509 extern SS_String GetStr(EPWR_WAKEUP_FACTOR_TYPE f_enum);
511 /////////////////////////////////////////////////////////////////////////////////////
512 /// \ingroup GetStr JP_ZPT
513 /// \~english @par Summary
514 /// change member from EFrameworkunifiedStatus type to string
515 /// \~english @param [in] f_enum
516 /// EFrameworkunifiedStatus - the member what will convert farm EFrameworkunifiedStatus type to string type.Status and return types.
518 /// typedef enum eFrameworkunifiedStatus {
519 /// eFrameworkunifiedStatusEmptyMediaList = -10, ///< Empty media list
520 /// eFrameworkunifiedStatusSessionLimitMaxedOut = -9, ///< Maximum session limit reached
521 /// eFrameworkunifiedStatusDbRecNotFound = -8, ///< Database record not found
522 /// eFrameworkunifiedStatusDbResultError = -7, ///< Database result error
523 /// eFrameworkunifiedStatusDbExecuteFail = -6, ///< Database execute fail
524 /// eFrameworkunifiedStatusSemCloseFail = -5, ///< Semaphore close failed
525 /// eFrameworkunifiedStatusSemUnlockFail = -4, ///< Semaphore unlock failed
526 /// eFrameworkunifiedStatusSemLockFail = -3, ///< Semaphore lock failed
527 /// eFrameworkunifiedStatusFail = -2, ///< Failed
528 /// eFrameworkunifiedStatusErrOther = -1, ///< Unknown error
529 /// eFrameworkunifiedStatusOK = 0, ///< Success / Pass / OK
530 /// eFrameworkunifiedStatusInvldBuf = 1, ///< Invalid buffer
531 /// eFrameworkunifiedStatusInvldHandle = 2, ///< Invalid handle
532 /// eFrameworkunifiedStatusInvldHndlType = 3, ///< Invalid handle type
533 /// eFrameworkunifiedStatusInvldQName = 4, ///< Invalid messasge queue name
534 /// eFrameworkunifiedStatusMsgQFull = 5, ///< Message queue full
535 /// eFrameworkunifiedStatusInvldNotification = 6,///< The Notification event not present
536 /// eFrameworkunifiedStatusInvldParam = 7, ///< Invalid parameter
537 /// eFrameworkunifiedStatusInvldBufSize = 8, ///< Buf size too small
538 /// eFrameworkunifiedStatusInvldID = 9, ///< Unrecognized ID
539 /// eFrameworkunifiedStatusCannotRelease = 10, ///< Cannot release resource
540 /// eFrameworkunifiedStatusBadConnection = 11, ///< Could not locate resource
541 /// eFrameworkunifiedStatusExit = 12, ///< Normal application termination
542 /// eFrameworkunifiedStatusNotImplemented = 13, ///< incomplete feature
543 /// eFrameworkunifiedStatusThreadBusy = 14, ///< Joined thread is already being joined
544 /// eFrameworkunifiedStatusThreadSelfJoin = 15, ///< Thread is joining itself
545 /// eFrameworkunifiedStatusThreadInvalidVal = 16, ///< Invalid value passed
546 /// eFrameworkunifiedStatusThreadNotExist = 17, ///< The thread does not exist
547 /// eFrameworkunifiedStatusFault = 18, ///< A fault occurred while attempting to make call
548 /// eFrameworkunifiedStatusServNotFound = 19, ///< Service not present in serv dir
549 /// eFrameworkunifiedStatusServerInUse = 20, ///< Service already processing 1 client request
550 /// eFrameworkunifiedStatusDbIndexing = 21, ///< Database Indexing in progress
551 /// eFrameworkunifiedStatusNullPointer = 22,
552 /// eFrameworkunifiedStatusMsgNotProcessed = 23,
553 /// eFrameworkunifiedStatusFileLoadSuccess = 24, ///< File Load Success
554 /// eFrameworkunifiedStatusFileLoadError = 25, ///< File Load Error
555 /// eFrameworkunifiedStatusAccessError = 26, ///< Error when accessing resource
556 /// eFrameworkunifiedStatusDuplicate = 27, ///< Duplicate entry
557 /// eFrameworkunifiedStatusMsgQEmpty = 28, ///< Message queue empty
558 /// eFrameworkunifiedStatusThreadAlreadyRunning = 29,
559 /// eFrameworkunifiedStatusErrNoEBADF = 30, ///< Bad file descriptor
560 /// eFrameworkunifiedStatusErrNoEAGAIN = 31, ///< Resource unavailable, try again
561 /// eFrameworkunifiedStatusErrNoEINTR = 32, ///< Interrupted system call
562 /// eFrameworkunifiedStatusSessionErr = 33, ///< Error in session handling
563 /// eFrameworkunifiedStatusDBCorrupt = 34, ///< Database corrupt
564 /// eFrameworkunifiedStatusDBFileNotFound = 35 ///< Database file not found
565 /// } EFrameworkunifiedStatus, *PEFrameworkunifiedStatus;
567 /// \~english @retval SS_String
568 /// \~english @par Preconditions
570 /// \~english @par Change of the internal state
571 /// - The internal state is not changed.
572 /// \~english @par Causes of failures
574 /// \~english @par Classification
576 /// \~english @par Type
578 /// \~english @par Detail
579 /// change member from EFrameworkunifiedStatus type to string. \n
581 ////////////////////////////////////////////////////////////////////////////////////
582 extern SS_String GetStr(EFrameworkunifiedStatus f_enum);
584 /////////////////////////////////////////////////////////////////////////////////////
586 /// \~english @par Summary
587 /// change member from ESMBootModeInfo type to string
588 /// \~english @param [in] f_enum
589 /// ESMBootModeInfo - the member what will convert farm ESMBootModeInfo type to string type.The type of boot
590 /// mode information.
593 /// e_SS_SM_BOOT_MODE_INVALID = -1
594 /// , e_SS_SM_BOOT_MODE_APPLICATION
595 /// , e_SS_SM_BOOT_MODE_PROGRAMMING
596 /// }ESMBootModeInfo;
598 /// \~english @retval SS_String
599 /// \~english @par Preconditions
601 /// \~english @par Change of the internal state
602 /// - The internal state is not changed.
603 /// \~english @par Causes of failures
605 /// \~english @par Classification
607 /// \~english @par Type
609 /// \~english @par Detail
610 /// change member from ESMBootModeInfo type to string. \n
612 ////////////////////////////////////////////////////////////////////////////////////
613 extern SS_String GetStr(ESMBootModeInfo f_enum);
615 /////////////////////////////////////////////////////////////////////////////////////
617 /// \~english @par Summary
618 /// change member from ESMCpuResetReason type to string
619 /// \~english @param [in] f_enum
620 /// ESMCpuResetReason - the member what will convert farm ESMCpuResetReason type to string type.The type of CPU
624 /// e_SS_SM_CPU_RESET_REASON_INVALID = -1
625 /// , e_SS_SM_CPU_RESET_REASON_NORMAL = 0
626 /// , e_SS_SM_CPU_RESET_REASON_DATA_RESET
627 /// , e_SS_SM_CPU_RESET_REASON_USER_FORCE_RESET
628 /// , e_SS_SM_CPU_RESET_REASON_GENERIC
629 /// , e_SS_SM_CPU_RESET_REASON_GENERIC_ERR = e_SS_SM_CPU_RESET_REASON_GENERIC
630 /// , e_SS_SM_CPU_RESET_REASON_DSP_ERR
631 /// , e_SS_SM_CPU_RESET_REASON_IMMRESET_NORMAL
632 /// , e_SS_SM_CPU_RESET_REASON_CRITICAL_ERR
633 /// }ESMCpuResetReason;
635 /// \~english @retval SS_String
636 /// \~english @par Preconditions
638 /// \~english @par Change of the internal state
639 /// - The internal state is not changed.
640 /// \~english @par Causes of failures
642 /// \~english @par Classification
644 /// \~english @par Type
646 /// \~english @par Detail
647 /// change member from ESMCpuResetReason type to string. \n
649 ////////////////////////////////////////////////////////////////////////////////////
650 extern SS_String GetStr(ESMCpuResetReason f_enum);
652 /////////////////////////////////////////////////////////////////////////////////////
654 /// \~english @par Summary
655 /// change member from \ref _SS_SystemManagerProtocol "SS_SystemManagerProtocol" type to string
656 /// \~english @param [in] f_enum
657 /// \ref _SS_SystemManagerProtocol "SS_SystemManagerProtocol" - the member what will convert farm \ref SS_SystemManagerProtocol "SS_SystemManagerProtocol" type to string
658 /// type.The type of system manager protocol.
659 /// \~english @retval SS_String
660 /// \~english @par Preconditions
662 /// \~english @par Change of the internal state
663 /// - The internal state is not changed.
664 /// \~english @par Causes of failures
666 /// \~english @par Classification
668 /// \~english @par Type
670 /// \~english @par Detail
671 /// change member from \ref _SS_SystemManagerProtocol) "SS_SystemManagerProtocol" type to string. \n
673 ////////////////////////////////////////////////////////////////////////////////////
674 extern SS_String GetStr(SS_SystemManagerProtocol f_enum);
676 #endif /* SS_STRING_MAPS_H_ */ // NOLINT (build/header_guard)
677 // EOF ss_string_maps.h