systemservice/config/library/system_manager_config/include/system_service/ss_access_if_private.h

   1 /*
   2  * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
   3  *
   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
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16 /**
  17  * @file ss_access_if_private.h
  18  * @brief \~english This file contains declaration of structures RAM_AccessPrivate and ROM_AccessPrivate
  19  */
  20 /** @addtogroup BaseSystem
  21  *  @{
  22  */
  23 /** @addtogroup system_service
  24  *  @ingroup BaseSystem
  25  *  @{
  26  */
  27 /** @addtogroup config
  28  *  @ingroup system_service
  29  *  @{
  30  */
  31 #ifndef CONFIG_LIBRARY_SYSTEM_MANAGER_CONFIG_INCLUDE_SYSTEM_SERVICE_SS_ACCESS_IF_PRIVATE_H_
  32 #define CONFIG_LIBRARY_SYSTEM_MANAGER_CONFIG_INCLUDE_SYSTEM_SERVICE_SS_ACCESS_IF_PRIVATE_H_
  33
  34 #include <system_service/ss_sm_rom_access.h>
  35 #include <system_service/ss_sm_ram_access.h>
  36
  37 //  Should be design the data so that the default value is 0.
  38
  39 //  Product private area for DRAM BACKUP
  40
  41 /**
  42  * @struct RAM_AccessPrivate
  43  * @brief \~english RAM Access Private data define
  44  */
  45 typedef struct {
  46   union {
  47     //! \~english _CWORD80_ error define
  48     struct {
  49       /*
  50        *  Note.
  51        *  This feature needs to be defined depending on the product specification by the vendor.
  52        */
  53     };
  54     //! \~english RAM product private max
  55     uint8_t max[RAM_PRODUCT_PRIVATE_MAX];
  56   };
  57 } RAM_AccessPrivate;
  58
  59 /**
  60  * @struct ROM_AccessPrivate
  61  * @brief \~english ROM Access Private data define
  62  */
  63 typedef struct {
  64   union {
  65     //  Since data is accessed with 32 bit width at the low level, data must be allocated using 32 bits algin
  66     struct {
  67       /*
  68        *  Note.
  69        *  This feature needs to be defined depending on the product specification by the vendor.
  70        */
  71     };
  72     //! \~english ROM product private max
  73     uint8_t max[ROM_PRODUCT_PRIVATE_MAX];
  74   };
  75 } ROM_AccessPrivate;
  76
  77 #endif  // CONFIG_LIBRARY_SYSTEM_MANAGER_CONFIG_INCLUDE_SYSTEM_SERVICE_SS_ACCESS_IF_PRIVATE_H_
  78 /** @}*/
  79 /** @}*/
  80 /** @}*/