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
|
/**
****************************************************************************************
*
* @file prf.h
*
* @brief Entry point of profile header file.
*
* Used to manage life cycle of profiles
*
* Copyright (C) RivieraWaves 2009-2016
*
****************************************************************************************
*/
#ifndef _PRF_H_
#define _PRF_H_
/**
****************************************************************************************
* @addtogroup PROFILE PROFILES
* @ingroup ROOT
* @brief Bluetooth Low Energy Host Profiles
*
* The PROFILE of the stack contains the profile layers (@ref PROX "PROXIMITY",
* @ref HTP "HTP",@ref FIND "FIND ME" @ref BPS "Blood Pressure").
****************************************************************************************
*/
/**
****************************************************************************************
* @addtogroup PRF
* @ingroup PROFILE
* @brief Definitions of Profile management API
*
* @{
****************************************************************************************
*/
/*
* INCLUDE FILES
****************************************************************************************
*/
#include "rwip_config.h"
#if (BLE_PROFILES)
#include "ke_task.h"
#include "gapm_task.h"
#include "prf_get_proto.h"
/*
* DEFINES
****************************************************************************************
*/
/**
* Profile task fields
*
* 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
* +----+----+----+----+----+----+----+----+----+----+----+----+----+----+----+----+
* | MI | TASK Number |
* +----+----+----+----+----+----+----+----+----+----+----+----+----+----+----+----+
*
* Bit [0-14] : Task number value
* Bit [15] : Task is multi-instantiated (Connection index is conveyed)
*/
enum prf_perm_mask
{
/// Task number value
PERM_MASK_PRF_TASK = 0x7FFF,
PERM_POS_PRF_TASK = 0,
/// Task is multi-instantiated
PERM_MASK_PRF_MI = 0x8000,
PERM_POS_PRF_MI = 15,
};
/*
* TYPE DEFINITIONS
****************************************************************************************
*/
/// Profile Environment Data
typedef struct prf_env
{
/// Application Task Number - if MSB bit set, Multi-Instantiated task
ke_task_id_t app_task;
/// Profile Task Number - if MSB bit set, Multi-Instantiated task
ke_task_id_t prf_task;
} prf_env_t;
/// Profile task environment variable definition to dynamically allocate a Task.
struct prf_task_env
{
/// Profile Task description
struct ke_task_desc desc;
/// pointer to the allocated memory used by profile during runtime.
prf_env_t* env;
/// Profile Task Number
ke_task_id_t task;
/// Profile Task Identifier
ke_task_id_t id;
};
/**
****************************************************************************************
* @brief Initialization of the Profile module.
* This function performs all the initializations of the Profile module.
* - Creation of database (if it's a service)
* - Allocation of profile required memory
* - Initialization of task descriptor to register application
* - Task State array
* - Number of tasks
* - Default task handler
*
* @param[out] env Collector or Service allocated environment data.
* @param[in|out] start_hdl Service start handle (0 - dynamically allocated), only applies for services.
* @param[in] app_task Application task number.
* @param[in] sec_lvl Security level (AUTH, EKS and MI field of @see enum attm_value_perm_mask)
* @param[in] param Configuration parameters of profile collector or service (32 bits aligned)
*
* @return status code to know if profile initialization succeed or not.
****************************************************************************************
*/
typedef uint8_t (*prf_init_fnct) (struct prf_task_env* env, uint16_t* start_hdl, uint16_t app_task, uint8_t sec_lvl, void* params);
/**
****************************************************************************************
* @brief Destruction of the Profile module - due to a reset for instance.
* This function clean-up allocated memory (attribute database is destroyed by another
* procedure)
*
* @param[in|out] env Collector or Service allocated environment data.
****************************************************************************************
*/
typedef void (*prf_destroy_fnct) (struct prf_task_env* env);
/**
****************************************************************************************
* @brief Handles Connection creation
*
* @param[in|out] env Collector or Service allocated environment data.
* @param[in] conidx Connection index
****************************************************************************************
*/
typedef void (*prf_create_fnct) (struct prf_task_env* env, uint8_t conidx);
/**
****************************************************************************************
* @brief Handles Disconnection
*
* @param[in|out] env Collector or Service allocated environment data.
* @param[in] conidx Connection index
* @param[in] reason Detach reason
****************************************************************************************
*/
typedef void (*prf_cleanup_fnct) (struct prf_task_env* env, uint8_t conidx, uint8_t reason);
/// Profile task callbacks.
struct prf_task_cbs
{
/// Initialization callback
prf_init_fnct init;
/// Destroy profile callback
prf_destroy_fnct destroy;
/// Connection callback
prf_create_fnct create;
/// Disconnection callback
prf_cleanup_fnct cleanup;
};
/// Profile Manager environment structure
struct prf_env_tag
{
/// Array of profile tasks that can be managed by Profile manager.
struct prf_task_env prf[BLE_NB_PROFILES];
};
/*
* MACROS
****************************************************************************************
*/
/*
* GLOBAL VARIABLE DECLARATIONS
****************************************************************************************
*/
extern struct prf_env_tag prf_env;
/*
* FUNCTION DECLARATIONS
****************************************************************************************
*/
/**
****************************************************************************************
* @brief Perform Profile initialization
*
* @param[in] reset Reset requested or basic initialization
****************************************************************************************
*/
void prf_init(bool reset);
/**
****************************************************************************************
* @brief Create Profile (collector or service) task creation and initialize it.
*
* @param[in|out] params Collector or Service parameter used for profile task creation
* @param[out] prf_task Allocated Task number
*
* @return status of adding profile task
****************************************************************************************
*/
uint8_t prf_add_profile(struct gapm_profile_task_add_cmd * params, ke_task_id_t *prf_task);
/**
****************************************************************************************
* @brief Link creation event, update profiles states.
*
* @param[in] conidx connection index
*
****************************************************************************************
*/
void prf_create(uint8_t conidx);
/**
****************************************************************************************
* @brief Link disconnection event, clean-up profiles.
*
* @param[in] conidx connection index
* @param[in] reason detach reason
*
****************************************************************************************
*/
void prf_cleanup(uint8_t conidx, uint8_t reason);
/**
****************************************************************************************
* @brief Retrieve environment variable allocated for a profile
*
* @param[in] prf_id Profile Task Identifier
*
* @return Environment variable allocated for a profile
****************************************************************************************
*/
prf_env_t* prf_env_get(uint16_t prf_id);
/**
****************************************************************************************
* @brief Retrieve source profile task number value
*
* @param[in] env Profile Environment
* @param[in] conidx Connection index
*
* @return Source profile task number value
****************************************************************************************
*/
ke_task_id_t prf_src_task_get(prf_env_t* env, uint8_t conidx);
/**
****************************************************************************************
* @brief Retrieve destination application task number value
*
* @param[in] env Profile Environment
* @param[in] conidx Connection index
*
* @return Destination application task number value
****************************************************************************************
*/
ke_task_id_t prf_dst_task_get(prf_env_t* env, uint8_t conidx);
/**
****************************************************************************************
* @brief Retrieve Task Identifier from Task number
* (automatically update index of task in returned task id)
*
* @param task Task number
* @return Task Identifier
****************************************************************************************
*/
ke_task_id_t prf_get_id_from_task(ke_msg_id_t task);
/**
****************************************************************************************
* @brief Retrieve Task Number from Task Identifier
* (automatically update index of task in returned task id)
*
* @param id Task Identifier
* @return Task Number
****************************************************************************************
*/
ke_task_id_t prf_get_task_from_id(ke_msg_id_t id);
#endif // (BLE_PROFILES)
/// @} PRF
#endif /* _PRF_H_ */
|
