service/vehicle/positioning_base_library/library/include/vehicle_service/pos_message_header.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 #ifndef _POS_MESSAGE_HEADER_  // NOLINT(build/header_guard)
  18 #define _POS_MESSAGE_HEADER_
  19
  20 /**
  21  * @file pos_message_header.h
  22  * @brief Header file for message data definitions
  23  */
  24
  25 /** @addtogroup BaseSystem
  26  *  @{
  27  */
  28 /** @addtogroup vehicle_service
  29  *  @ingroup BaseSystem
  30  *  @{
  31  */
  32 /** @addtogroup positioning_base_library
  33  *  @ingroup vehicle_service
  34  *  @{
  35  */
  36
  37 #include <sys/types.h>
  38
  39 /**
  40  * @struct T_APIMSG_HEADER
  41  * \~english _CWORD64_API message header structure
  42  */
  43 typedef struct {
  44     uint16_t replyid;          //!< \~english message send result notify dest ID
  45     uint16_t sndpno;           //!< \~english message send source process No
  46     uint16_t respno;           //!< \~english message response process No
  47     uint16_t cid;              //!< \~english message command ID
  48     uint16_t msgbodysize;      //!< \~english message body size
  49     uint8_t  rid;              //!< \~english message resource ID */
  50     uint8_t  reserve;          //!< \~english reserve
  51     uint8_t  filler[2];        //!< \~english filter
  52 } T_APIMSG_HEADER;
  53
  54 /**
  55  * @struct T_APIMSG_MSGBUF_HEADER
  56  * \~english _CWORD64_API message buffer header structure
  57  */
  58 typedef struct {
  59     uint32_t  signo;  //!< \~english signal No, _pb_SndMsg to set 0
  60     T_APIMSG_HEADER hdr;   //!< \~english message header
  61 } T_APIMSG_MSGBUF_HEADER;
  62
  63 /**
  64  * @struct _CWORD64_MSG_LOG_HDR
  65  * \~english _CWORD64_API message log header structure
  66  */
  67 typedef struct {
  68     uint32_t    kickTime;    //!< \~english kick time
  69     uint32_t    srCid;       //!< \~english message command ID
  70     uint32_t    pno;         //!< \~english process No
  71     uint32_t    dataBytes;   //!< \~english data size
  72 } _CWORD64_MSG_LOG_HDR;
  73
  74 /** @}*/  // end of positioning_base_library
  75 /** @}*/  // end of vehicle_service
  76 /** @}*/  // end of BaseSystem
  77 #endif  // _POS_MESSAGE_HEADER_