summaryrefslogtreecommitdiffstats
path: root/stub/vehicle/client/include/stub/Vehicle_Sensor_Common_API.h
blob: 810e46a125cbf76f4eb43cf19a8af029e64616ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
/*
 * @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.
 */

#ifndef VEHICLE_CLIENT_INCLUDE_VEHICLE_SERVICE_VEHICLE_SENSOR_COMMON_API_H_
#define VEHICLE_CLIENT_INCLUDE_VEHICLE_SERVICE_VEHICLE_SENSOR_COMMON_API_H_

/**
 * @file Vehicle_Sensor_Common_API.h
 * @brief vehicle common id defined header file
 */

/** @addtogroup BaseSystem
 *  @{
 */
/** @addtogroup vehicle_service
 *  @ingroup BaseSystem
 *  @{
 */
/** @addtogroup vehicle
 *  @ingroup vehicle_service
 *  @{
 */

/******************************************************************************
 * File name    :Vehicle_Sensor_Common_API.h
 * System name    :_CWORD107_
 * Subsystem name  :Vehicle I/F library, Sensor I/F library
 ******************************************************************************/

/************************************************************************
 *      Macro definition                          *
 ************************************************************************/

#if 1                    // Ignore -> MISRA-C++ Rules 16-1-2, 16-2-2
/* #GPF_60_023 For testing */
#ifndef CONFIG_EXTTERM_INPUT_DAB2BIT    // Ignore -> MISRA-C++ Rules 16-1-2, 16-2-2
/**
 * \~english  DAB data 2 bits macro
 */
#define CONFIG_EXTTERM_INPUT_DAB2BIT 1    // Ignore -> MISRA-C++ Rules 16-2-2
#endif
#ifndef CONFIG_EXTTERM_INPUT_GPS2BIT    // Ignore -> MISRA-C++ Rules 16-1-2, 16-2-2
/**
 * \~english  GPS data 2 bits macro
 */
#define CONFIG_EXTTERM_INPUT_GPS2BIT 1    // Ignore -> MISRA-C++ Rules 16-2-2
#endif
#ifndef CONFIG_EXTTERM_INPUT_IMAGETERMINAL  // Ignore -> MISRA-C++ Rules 16-1-2, 16-2-2
/**
 * \~english  Image terminal macro
 */
#define CONFIG_EXTTERM_INPUT_IMAGETERMINAL  1  // Ignore -> MISRA-C++ Rules 16-2-2
#endif
#endif
/* The above definition is a remnant of the external terminal processing part inside *
 * the sennsor that was enabled or disabled, and is not originally required at all.  *
 * Enable all sensor internal processing and then delete.  */

/*----------------------------------------------------------------------*
 *  Data ID corresponding to vehicle sensor information                 *
 *----------------------------------------------------------------------*/
/*
 *  Note.
 *  This feature needs to be defined by the vendor.
 */

/**
 * \~english  Destination information
 */
#define  VEHICLE_DID_DESTINATION      (0x00000001UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Hybrid electric vehicle information
 */
#define  VEHICLE_DID_HV          (0x00000002UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Steering wheel information
 */
#define  VEHICLE_DID_STEERING_WHEEL    (0x00000003UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Voltage
 */
#define  VEHICLE_DID_VB          (0x00000004UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  IG information
 */
#define  VEHICLE_DID_IG          (0x00000005UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Microphone information
 */
#define  VEHICLE_DID_MIC          (0x00000006UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Back door information
 */
#define  VEHICLE_DID_BACKDOOR      (0x00000007UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Parking brake information
 */
#define  VEHICLE_DID_PKB          (0x00000008UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  ADIM information
 */
#define  VEHICLE_DID_ADIM        (0x00000009UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Illumination information
 */
#define  VEHICLE_DID_ILL          (0x0000000AUL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  RHEOSTAT information
 */
#define  VEHICLE_DID_RHEOSTAT      (0x0000000BUL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  System temperature information
 */
#define  VEHICLE_DID_SYSTEMP        (0x0000000CUL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Reverse information
 */
#define  VEHICLE_DID_REV          (0x00000017UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Reverse information(line sensor)
 */
#define  VEHICLE_DID_REV_LINE      (0x0000000EUL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Reverse CAN information
 */
#define  VEHICLE_DID_REV_CAN        (0x0000000FUL)  // Ignore -> MISRA-C++ Rule 16-2-2
/**
 * \~english  SPEED information
 */
#define  VEHICLE_DID_SPEED        (0x00000010UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  SPEED PULSE information
 */
#define  VEHICLE_DID_SPEED_PULSE        (0x00000011UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  VB information
 */
#define  VEHICLE_DID_VBLOW        (0x00000012UL)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Drive information(2WD/4WD)
 */
#define  VEHICLE_DID_DVINF                (0x00000013UL)

/**
 * \~english  Transmission information
 */
#define  VEHICLE_DID_VARTRM1                (0x00000014UL)

/**
 * \~english  Shift position signal(R, P, N, D)
 */
#define  VEHICLE_DID_SHIFT                (0x00000015UL)

/**
 * \~english  Direct line sensor(PKB)
 */
#define  VEHICLE_DID_PKB_LINE              (0x00000016UL)

/**
 * \~english  D seat door signal switch
 */
#define VEHICLE_DID_DSEAT_DOOR              (0x0000000DUL)

/**
 * \~english  P seat door signal switch
 */
#define VEHICLE_DID_PSEAT_DOOR              (0x00000018UL)

/**
 * \~english  RR seat door signal switch
 */
#define VEHICLE_DID_RRSEAT_DOOR              (0x00000019UL)

/**
 * \~english  RL seat door signal switch
 */
#define VEHICLE_DID_RLSEAT_DOOR              (0x0000001AUL)

/**
 * \~english  IGP information
 */
#define VEHICLE_DID_IGP                      (0x0000001BUL)

/**
 * \~english  HV information status
 */
#define VEHICLE_DID_HV_STS              (0x0000001CUL)

/**
 * \~english  Shift position signal(Unspecified)
 */
#define VEHICLE_DID_SHIFT_U             (0x0000001DUL)

/**
 * \~english USB power supply
 */
#define VEHICLE_DID_USBPOWERSUPPLY      (0x800000A0UL)

/**
 * \~english  Analog Microphone Connect information
 */
#define  VEHICLE_DID_ANALOG_MIC        (0x800000B0UL)

/**
 * \~english  MultiMic Connect information
 */
#define  VEHICLE_DID_MULTI_MIC         (0x800000B1UL)

/*----------------------------------------------------------------------*
 *  Vehicle sensor information data                        *
 *----------------------------------------------------------------------*/
/**
 * \~english  OFF
 */
#define  VEHICLE_SNS_OFF          (0x00U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  ON
 */
#define  VEHICLE_SNS_ON          (0x01U)  // Ignore -> MISRA-C++ Rule 16-2-2

#define  VEHICLE_SNS_BLACKOUT    (0x02U)  // Disruptions
/**
 * \~english  Undefined
 */
#define  VEHICLE_SNS_UNDEF        (0x03U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Disconnection
 */
#define  VEHICLE_SNS_UNCONNECTION    (0x00U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Connection
 */
#define  VEHICLE_SNS_CONNECTION      (0x01U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Uncertainty
 */
#define  VEHICLE_SNS_BW_UNCERTAINTY   (0x02U)

/**
 * \~english  Unspecified
 */
#define  VEHICLE_SNS_UNSPECIFIED      (0x03U)  // Ignore -> MISRA-C++ Rule 16-2-2
/* #GPF_60_023 ADD START */
#if (CONFIG_EXTTERM_INPUT_DAB2BIT | CONFIG_EXTTERM_INPUT_GPS2BIT)    // Ignore -> MISRA-C++ Rules 16-1-2, 16-2-2
/**
 * \~english  Short
 */
#define  VEHICLE_SNS_SHORT        (0x02U)  // Ignore -> MISRA-C++ Rule 16-2-2
#endif
/* #GPF_60_023 ADD END */

/**
 * \~english  Hybrid electric vehicle
 */
#define  VEHICLE_SNS_HV          (0x01U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Plug-in hybrid electric vehicle
 */
#define  VEHICLE_SNS_PHV          (0x02U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Electric vehicle
 */
#define  VEHICLE_SNS_EV           (0x03U)

/**
 * \~english  Fuel Cell vehicle
 */
#define  VEHICLE_SNS_FCV          (0x04U)

/**
 * \~english  1 motor vehicle
 */
#define  VEHICLE_SNS_1MOT         (0x05U)

/**
 * \~english  Conventional(48V) vehicle
 */
#define  VEHICLE_SNS_48V          (0x06U)

/**
 *  \~english S&S vehicle
 */
#define  VEHICLE_SNS_SANDS        (0x07U)

/**
 * \~english  Conventional vehicle
 */
#define  VEHICLE_SNS_NONHV        (0x00U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Two wheel drive
 */
#define  VEHICLE_SNS_2WD          (0x00U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**gb
 * \~english  Four wheel drive
 */
#define  VEHICLE_SNS_4WD          (0x01U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Left handle
 */
#define  VEHICLE_SNS_LH          (0x01U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Right handle
 */
#define  VEHICLE_SNS_RH          (0x02U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Close
 */
#define  VEHICLE_SNS_CLOSE        (0x00U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Open
 */
#define  VEHICLE_SNS_OPEN        (0x01U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Back door uncertainty
 */
#define  VEHICLE_SNS_BD_UNCERTAINTY    (0x02U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  ADIM uncertainty
 */
#define  VEHICLE_SNS_ADIM_UNCERTAINTY  (0x00U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  ADIM undefined
 */
#define  VEHICLE_SNS_ADIM_UNDEF      (0x01U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  ADIM off
 */
#define  VEHICLE_SNS_ADIM_OFF      (0x02U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  ADIM on
 */
#define  VEHICLE_SNS_ADIM_ON        (0x03U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Drive information(2WD)
 */
#define  VEHICLE_SNS_DVINF_2WD      (0x00U)

/**
 * \~english  Drive information(4WD)
 */
#define  VEHICLE_SNS_DVINF_4WD      (0x01U)

/**
 * \~english  Drive information uncertainty
 */
#define  VEHICLE_SNS_DVINF_UNCERTAINTY  (0x03U)

/**
 * \~english  Transmission information(MT)
 */
#define  VEHICLE_SNS_VARTRM1_MT      (0x00U)

/**
 * \~english  Transmission information(AT)
 */
#define  VEHICLE_SNS_VARTRM1_AT      (0x01U)

/**
 * \~english  Transmission information(CVT)
 */
#define  VEHICLE_SNS_VARTRM1_CVT      (0x02U)

/**
 * \~english  Transmission information(MMT)
 */
#define  VEHICLE_SNS_VARTRM1_MMT      (0x03U)

/**
 * \~english  Transmission information(SMT)
 */
#define  VEHICLE_SNS_VARTRM1_SMT      (0x04U)

/**
 * \~english  Transmission information(HV_AT)
 */
#define  VEHICLE_SNS_VARTRM1_HV_AT    (0x05U)

/**
 * \~english  Transmission information uncertainty
 */
#define  VEHICLE_SNS_VARTRM1_UNCERTAINTY  (0x0FU)

/**
 * \~english  D seat door uncertainty
 */
#define VEHICLE_SNS_DS_UNCERTAINTY    (0x02U)

/**
 * \~english  P seat door uncertainty
 */
#define VEHICLE_SNS_PS_UNCERTAINTY    (0x02U)

/**
 * \~english  RR seat door uncertainty
 */
#define VEHICLE_SNS_RRS_UNCERTAINTY    (0x02U)

/**
 * \~english  RL seat door uncertainty
 */
#define VEHICLE_SNS_RLS_UNCERTAINTY    (0x02U)

/**
 * \~english  HV information not decision
 */
#define  VEHICLE_SNS_HV_NOT_DECISION    (0x00U)

/**
 * \~english  HV information decision
 */
#define VEHICLE_SNS_HV_DECISION      (0x01U)

/**
 * @enum VehicleSnsAnlogMicBit
 * \~english  ANALOGMIC connect bit information
 */
enum VehicleSnsAnlogMicBit {
  VEHICLE_SNS_ANALOG_MIC1_BIT = 0x02,  //!< \~english ANALOGMIC1 connect
  VEHICLE_SNS_ANALOG_MIC2_BIT = 0x04,  //!< \~english ANALOGMIC2 connect
};

/**
 * @enum VehicleSnsMultiMicBit
 * \~english  MULTI MIC connect bit information
 */
enum VehicleSnsMultiMicBit {
  VEHICLE_SNS_A2B_HUB_BIT = 0x01,           //!< \~english A2BHUB connect
  VEHICLE_SNS_MULTI_MIC1_BIT = 0x02,        //!< \~english MULTIMIC1 connect
  VEHICLE_SNS_MULTI_MIC2_BIT = 0x04,        //!< \~english MULTIMIC2 connect
  VEHICLE_SNS_MULTI_MIC3_BIT = 0x08,        //!< \~english MULTIMIC3 connect
  VEHICLE_SNS_MULTI_MIC4_BIT = 0x10,        //!< \~english MULTIMIC4 connect
  VEHICLE_SNS_MULTI_MIC5_BIT = 0x20,        //!< \~english MULTIMIC5 connect
  VEHICLE_SNS_MULTI_MIC6_BIT = 0x40,        //!< \~english MULTIMIC6 connect
  VEHICLE_SNS_ANC_BIT = 0x80,               //!< \~english ANC connect
};

/*-------------------------------------------------------------------------------
 * Time status return value
 -------------------------------------------------------------------------------*/
/**
 * \~english  Real time clock
 */
#define  GPS_TIMESTS_RTC      (0x02U)  // Ignore -> MISRA-C++ Rule 16-2-2

/**
 * \~english  Exception time
 */
#define  GPS_TIMESTS_NG      (0x03U)  // Ignore -> MISRA-C++ Rule 16-2-2

/** @}*/  // end of vehicle
/** @}*/  // end of VehicleService
/** @}*/  // end of BaseSystem

#endif  // VEHICLE_CLIENT_INCLUDE_VEHICLE_SERVICE_VEHICLE_SENSOR_COMMON_API_H_