-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbhy_system_param.h
162 lines (145 loc) · 6.16 KB
/
bhy_system_param.h
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
/**
* Copyright (c) 2025 Bosch Sensortec GmbH. All rights reserved.
*
* BSD-3-Clause
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @file bhy_system_param.h
* @date 2025-03-28
* @version v2.1.0
*
*/
#ifndef __BHY_SYSTEM_PARAM_H__
#define __BHY_SYSTEM_PARAM_H__
/* Start of CPP Guard */
#ifdef __cplusplus
extern "C" {
#endif /*__cplusplus */
#include <stdint.h>
#include <stdlib.h>
#include "bhy.h"
#include "bhy_system_param_defs.h"
/*!
* @brief Set Meta Event Control for FIFO (wake-up and non-wake-up)
*
* @param[in] param : Parameter to set.
* @param[in] info : Buffer containing new parameter value.
* @param[in] dev : Device reference.
*
* @return BHY API error codes.
*/
int8_t bhy_system_param_set_meta_event_control(uint16_t param,
const bhy_system_param_multi_meta_event_ctrl_t *info,
struct bhy_dev *dev);
/*!
* @brief Get Meta Event Control for FIFOs (wake-up and non-wake-up)
*
* @param[in] param : Parameter to set.
* @param[out] info : Buffer containing new parameter value.
* @param[in] dev : Device reference.
*
* @return BHY API error codes.
*/
int8_t bhy_system_param_get_meta_event_control(uint16_t param,
bhy_system_param_multi_meta_event_ctrl_t *info,
struct bhy_dev *dev);
/*!
* @brief Function set the Wakeup FIFO control register
* @param[in] fifo_ctrl : Fifo control
* @param[in] dev : Device reference
* @return API error codes
*/
int8_t bhy_system_param_set_wakeup_fifo_control(const struct bhy_system_param_fifo_control *fifo_ctrl,
struct bhy_dev *dev);
/*!
* @brief Function set the non-wakeup FIFO control register
* @param[in] fifo_ctrl : FIFO control
* @param[in] dev : Device reference
* @return API error codes
*/
int8_t bhy_system_param_set_nonwakeup_fifo_control(const struct bhy_system_param_fifo_control *fifo_ctrl,
struct bhy_dev *dev);
/*!
* @brief Function get the FIFO control register
* @param[out] fifo_ctrl : FIFO control
* @param[in] dev : Device reference
* @return API error codes
*/
int8_t bhy_system_param_get_fifo_control(struct bhy_system_param_fifo_control *fifo_ctrl, struct bhy_dev *dev);
/*!
* @brief Function get the firmware version
* @param[out] fw_ver : Reference to the data buffer to store firmware version
* @param[in] dev : Device reference
* @return API error codes
*/
int8_t bhy_system_param_get_firmware_version(struct bhy_system_param_firmware_version *fw_ver, struct bhy_dev *dev);
/*!
* @brief Function get the timestamp
* @param[out] ts : Reference to the data buffer to store timestamp
* @param[in] dev : Device reference
* @return API error codes
*/
int8_t bhy_system_param_get_timestamps(struct bhy_system_param_timestamp *ts, struct bhy_dev *dev);
/*!
* @brief Function get the virtual sensor present
* @param[in] dev : Device reference
* @return API error codes
*/
int8_t bhy_system_param_get_virtual_sensor_present(struct bhy_dev *dev);
/*!
* @brief Function get the physical sensor present
* @param[in] dev : Device reference
* @return API error codes
*/
int8_t bhy_system_param_get_physical_sensor_present(struct bhy_dev *dev);
/**
* @brief Function to get the physical sensor information of a virtual sensor
* @param[in] sensor_id : Sensor ID of the virtual sensor
* @param[out] info : Reference to the data buffer to store the physical sensor info
* @param[in] dev : Device reference
* @return API error codes
*/
int8_t bhy_system_param_get_physical_sensor_info(uint8_t sensor_id,
struct bhy_system_param_phys_sensor_info *info,
struct bhy_dev *dev);
/**
* @brief Function to set the orientation matrix of physical sensor
* @param[in] sensor_id : Sensor ID of the virtual sensor
* @param[out] orient_matrix : Reference to the data buffer to store the orientation matrix
* @param[in] dev : Device reference
* @return API error codes
*/
int8_t bhy_system_param_set_physical_sensor_info(uint8_t sensor_id,
const struct bhy_system_param_orient_matrix *orient_matrix,
struct bhy_dev *dev);
/* End of CPP Guard */
#ifdef __cplusplus
}
#endif /*__cplusplus */
#endif