Zephyr Project API 3.7.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
csip.h
Go to the documentation of this file.
1
6/*
7 * Copyright (c) 2021-2024 Nordic Semiconductor ASA
8 *
9 * SPDX-License-Identifier: Apache-2.0
10 */
11
12#ifndef ZEPHYR_SUBSYS_BLUETOOTH_AUDIO_CSIP_H_
13#define ZEPHYR_SUBSYS_BLUETOOTH_AUDIO_CSIP_H_
14
30#include <stdbool.h>
31#include <stddef.h>
32#include <stdint.h>
33
34#include <zephyr/autoconf.h>
38#include <zephyr/kernel.h>
39#include <zephyr/sys/slist.h>
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
46#define BT_CSIP_SET_COORDINATOR_DISCOVER_TIMER_VALUE K_SECONDS(10)
47
52#if defined(CONFIG_BT_CSIP_SET_COORDINATOR)
53#define BT_CSIP_SET_COORDINATOR_MAX_CSIS_INSTANCES CONFIG_BT_CSIP_SET_COORDINATOR_MAX_CSIS_INSTANCES
54#else
55#define BT_CSIP_SET_COORDINATOR_MAX_CSIS_INSTANCES 0
56#endif /* CONFIG_BT_CSIP_SET_COORDINATOR */
57
59#define BT_CSIP_READ_SIRK_REQ_RSP_ACCEPT 0x00
61#define BT_CSIP_READ_SIRK_REQ_RSP_ACCEPT_ENC 0x01
63#define BT_CSIP_READ_SIRK_REQ_RSP_REJECT 0x02
65#define BT_CSIP_READ_SIRK_REQ_RSP_OOB_ONLY 0x03
66
68#define BT_CSIP_SIRK_SIZE 16
69
71#define BT_CSIP_RSI_SIZE 6
72
73/* Coordinate Set Identification Service Error codes */
75#define BT_CSIP_ERROR_LOCK_DENIED 0x80
77#define BT_CSIP_ERROR_LOCK_RELEASE_DENIED 0x81
79#define BT_CSIP_ERROR_LOCK_INVAL_VALUE 0x82
81#define BT_CSIP_ERROR_SIRK_OOB_ONLY 0x83
83#define BT_CSIP_ERROR_LOCK_ALREADY_GRANTED 0x84
84
93#define BT_CSIP_DATA_RSI(_rsi) BT_DATA(BT_DATA_CSIS_RSI, _rsi, BT_CSIP_RSI_SIZE)
94
96struct bt_csip_set_member_svc_inst;
97
111 void (*lock_changed)(struct bt_conn *conn,
112 struct bt_csip_set_member_svc_inst *svc_inst,
113 bool locked);
114
128 uint8_t (*sirk_read_req)(struct bt_conn *conn,
129 struct bt_csip_set_member_svc_inst *svc_inst);
130};
131
140
148
155
164
167
168#if CONFIG_BT_CSIP_SET_MEMBER_MAX_INSTANCE_COUNT > 1 || defined(__DOXYGEN__)
178 const struct bt_gatt_service *parent;
179#endif /* CONFIG_BT_CSIP_SET_MEMBER_MAX_INSTANCE_COUNT > 1 */
180};
181
191void *bt_csip_set_member_svc_decl_get(const struct bt_csip_set_member_svc_inst *svc_inst);
192
209 struct bt_csip_set_member_svc_inst **svc_inst);
210
220int bt_csip_set_member_unregister(struct bt_csip_set_member_svc_inst *svc_inst);
221
228int bt_csip_set_member_sirk(struct bt_csip_set_member_svc_inst *svc_inst,
229 const uint8_t sirk[BT_CSIP_SIRK_SIZE]);
230
237int bt_csip_set_member_get_sirk(struct bt_csip_set_member_svc_inst *svc_inst,
239
250int bt_csip_set_member_generate_rsi(const struct bt_csip_set_member_svc_inst *svc_inst,
252
264int bt_csip_set_member_lock(struct bt_csip_set_member_svc_inst *svc_inst,
265 bool lock, bool force);
266
294
308
314
325 struct bt_conn *conn,
326 const struct bt_csip_set_coordinator_set_member *member,
327 int err, size_t set_count);
328
337int bt_csip_set_coordinator_discover(struct bt_conn *conn);
338
353
360typedef void (*bt_csip_set_coordinator_lock_set_cb)(int err);
361
373 struct bt_csip_set_coordinator_csis_inst *inst, bool locked);
374
384
400 const struct bt_csip_set_coordinator_set_info *set_info,
401 int err, bool locked,
403
426
436 struct bt_data *data);
437
446
459 const struct bt_csip_set_coordinator_set_info *set_info,
460 struct bt_csip_set_coordinator_set_member *members[],
461 size_t count);
462
487 const struct bt_csip_set_coordinator_set_member *members[],
489 const struct bt_csip_set_coordinator_set_info *set_info,
491
508 const struct bt_csip_set_coordinator_set_info *set_info);
509
524 const struct bt_csip_set_coordinator_set_info *set_info);
525
526#ifdef __cplusplus
527}
528#endif
529
534#endif /* ZEPHYR_SUBSYS_BLUETOOTH_AUDIO_CSIP_H_ */
Bluetooth subsystem core APIs.
ZTEST_BMEM int count
Definition main.c:33
Bluetooth connection handling.
Bluetooth Generic Access Profile defines and Assigned Numbers.
int bt_csip_set_coordinator_register_cb(struct bt_csip_set_coordinator_cb *cb)
Registers callbacks for csip_set_coordinator.
void(* bt_csip_set_coordinator_ordered_access_cb_t)(const struct bt_csip_set_coordinator_set_info *set_info, int err, bool locked, struct bt_csip_set_coordinator_set_member *member)
Callback for bt_csip_set_coordinator_ordered_access()
Definition csip.h:399
void(* bt_csip_set_coordinator_lock_set_cb)(int err)
Callback for locking a set across one or more devices.
Definition csip.h:360
void(* bt_csip_set_coordinator_sirk_changed_cb)(struct bt_csip_set_coordinator_csis_inst *inst)
Callback when the SIRK value of a set of a connected device changes.
Definition csip.h:382
bool(* bt_csip_set_coordinator_ordered_access_t)(const struct bt_csip_set_coordinator_set_info *set_info, struct bt_csip_set_coordinator_set_member *members[], size_t count)
Callback function definition for bt_csip_set_coordinator_ordered_access()
Definition csip.h:458
int bt_csip_set_coordinator_lock(const struct bt_csip_set_coordinator_set_member **members, uint8_t count, const struct bt_csip_set_coordinator_set_info *set_info)
Lock an array of set members.
#define BT_CSIP_SIRK_SIZE
Size of the Set Identification Resolving Key (SIRK)
Definition csip.h:68
#define BT_CSIP_SET_COORDINATOR_MAX_CSIS_INSTANCES
Defines the maximum number of Coordinated Set Identification service instances for the Coordinated Se...
Definition csip.h:55
void(* bt_csip_set_coordinator_lock_changed_cb)(struct bt_csip_set_coordinator_csis_inst *inst, bool locked)
Callback when the lock value on a set of a connected device changes.
Definition csip.h:372
int bt_csip_set_coordinator_release(const struct bt_csip_set_coordinator_set_member **members, uint8_t count, const struct bt_csip_set_coordinator_set_info *set_info)
Release an array of set members.
#define BT_CSIP_RSI_SIZE
Size of the Resolvable Set Identifier (RSI)
Definition csip.h:71
int bt_csip_set_coordinator_discover(struct bt_conn *conn)
Initialise the csip_set_coordinator instance for a connection.
struct bt_csip_set_coordinator_set_member * bt_csip_set_coordinator_set_member_by_conn(const struct bt_conn *conn)
Get the set member from a connection pointer.
int bt_csip_set_member_generate_rsi(const struct bt_csip_set_member_svc_inst *svc_inst, uint8_t rsi[6])
Generate the Resolvable Set Identifier (RSI) value.
int bt_csip_set_member_lock(struct bt_csip_set_member_svc_inst *svc_inst, bool lock, bool force)
Locks a specific Coordinated Set Identification Service instance on the server.
int bt_csip_set_member_unregister(struct bt_csip_set_member_svc_inst *svc_inst)
Unregister a Coordinated Set Identification Service instance.
int bt_csip_set_member_register(const struct bt_csip_set_member_register_param *param, struct bt_csip_set_member_svc_inst **svc_inst)
Register a Coordinated Set Identification Service instance.
int bt_csip_set_member_get_sirk(struct bt_csip_set_member_svc_inst *svc_inst, uint8_t sirk[16])
Get the SIRK of a service instance.
void * bt_csip_set_member_svc_decl_get(const struct bt_csip_set_member_svc_inst *svc_inst)
Get the service declaration attribute.
bool bt_csip_set_coordinator_is_set_member(const uint8_t sirk[16], struct bt_data *data)
Check if advertising data indicates a set member.
int bt_csip_set_coordinator_ordered_access(const struct bt_csip_set_coordinator_set_member *members[], uint8_t count, const struct bt_csip_set_coordinator_set_info *set_info, bt_csip_set_coordinator_ordered_access_t cb)
Access Coordinated Set devices in an ordered manner as a client.
int bt_csip_set_member_sirk(struct bt_csip_set_member_svc_inst *svc_inst, const uint8_t sirk[16])
Set the SIRK of a service instance.
void(* bt_csip_set_coordinator_discover_cb)(struct bt_conn *conn, const struct bt_csip_set_coordinator_set_member *member, int err, size_t set_count)
Callback for discovering Coordinated Set Identification Services.
Definition csip.h:324
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
Public kernel APIs.
static struct k_spinlock lock
Definition spinlock_error_case.c:13
#define bool
Definition stdbool.h:13
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
Struct to hold the Coordinated Set Identification Profile Set Coordinator callbacks.
Definition csip.h:409
bt_csip_set_coordinator_lock_set_cb lock_set
Callback when locking a set has finished.
Definition csip.h:413
bt_csip_set_coordinator_sirk_changed_cb sirk_changed
Callback when a set's SIRK has changed.
Definition csip.h:419
bt_csip_set_coordinator_discover_cb discover
Callback when discovery has finished.
Definition csip.h:411
bt_csip_set_coordinator_lock_set_cb release_set
Callback when unlocking a set has finished.
Definition csip.h:415
bt_csip_set_coordinator_lock_changed_cb lock_changed
Callback when a set's lock state has changed.
Definition csip.h:417
bt_csip_set_coordinator_ordered_access_cb_t ordered_access
Callback for the ordered access procedure.
Definition csip.h:421
Struct representing a coordinated set instance on a remote device.
Definition csip.h:301
struct bt_csip_set_coordinator_set_info info
Information about the coordinated set.
Definition csip.h:303
void * svc_inst
Internally used pointer value.
Definition csip.h:306
Information about a specific set.
Definition csip.h:268
uint8_t rank
The rank of the set on the remote device.
Definition csip.h:289
uint8_t sirk[16]
The 16 octet set Set Identity Resolving Key (SIRK)
Definition csip.h:275
bool lockable
Whether or not the set can be locked on this device.
Definition csip.h:292
uint8_t set_size
The size of the set.
Definition csip.h:282
Struct representing a remote device as a set member.
Definition csip.h:310
struct bt_csip_set_coordinator_csis_inst insts[0]
Array of Coordinated Set Identification Service instances for the remote device.
Definition csip.h:312
Callback structure for the Coordinated Set Identification Service.
Definition csip.h:99
uint8_t(* sirk_read_req)(struct bt_conn *conn, struct bt_csip_set_member_svc_inst *svc_inst)
Request from a peer device to read the sirk.
Definition csip.h:128
void(* lock_changed)(struct bt_conn *conn, struct bt_csip_set_member_svc_inst *svc_inst, bool locked)
Callback whenever the lock changes on the server.
Definition csip.h:111
Register structure for Coordinated Set Identification Service.
Definition csip.h:133
struct bt_csip_set_member_cb * cb
Pointer to the callback structure.
Definition csip.h:166
const struct bt_gatt_service * parent
Parent service pointer.
Definition csip.h:178
uint8_t sirk[16]
The unique Set Identity Resolving Key (SIRK)
Definition csip.h:147
bool lockable
Boolean to set whether the set is lockable by clients.
Definition csip.h:154
uint8_t rank
Rank of this device in this set.
Definition csip.h:163
uint8_t set_size
Size of the set.
Definition csip.h:139
Bluetooth data.
Definition bluetooth.h:454
GATT Service structure.
Definition gatt.h:196
static fdata_t data[2]
Definition test_fifo_contexts.c:15