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
|
/** @file
EFI Bluetooth IO Service Binding Protocol as defined in UEFI 2.5.
EFI Bluetooth IO Protocol as defined in UEFI 2.5.
The EFI Bluetooth IO Service Binding Protocol is used to locate EFI Bluetooth IO Protocol drivers to
create and destroy child of the driver to communicate with other Bluetooth device by using Bluetooth IO protocol.
Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
@par Revision Reference:
This Protocol is introduced in UEFI Specification 2.5
**/
#ifndef __EFI_BLUETOOTH_IO_PROTOCOL_H__
#define __EFI_BLUETOOTH_IO_PROTOCOL_H__
#include <IndustryStandard/Bluetooth.h>
#define EFI_BLUETOOTH_IO_SERVICE_BINDING_PROTOCOL_GUID \
{ \
0x388278d3, 0x7b85, 0x42f0, { 0xab, 0xa9, 0xfb, 0x4b, 0xfd, 0x69, 0xf5, 0xab } \
}
#define EFI_BLUETOOTH_IO_PROTOCOL_GUID \
{ \
0x467313de, 0x4e30, 0x43f1, { 0x94, 0x3e, 0x32, 0x3f, 0x89, 0x84, 0x5d, 0xb5 } \
}
typedef struct _EFI_BLUETOOTH_IO_PROTOCOL EFI_BLUETOOTH_IO_PROTOCOL;
///
/// EFI_BLUETOOTH_DEVICE_INFO
///
typedef struct {
///
/// The version of the structure
///
UINT32 Version;
///
/// 48bit Bluetooth device address.
///
BLUETOOTH_ADDRESS BD_ADDR;
///
/// Bluetooth PageScanRepetitionMode. See Bluetooth specification for detail.
///
UINT8 PageScanRepetitionMode;
///
/// Bluetooth ClassOfDevice. See Bluetooth specification for detail.
///
BLUETOOTH_CLASS_OF_DEVICE ClassOfDevice;
///
/// Bluetooth CloseOffset. See Bluetooth specification for detail.
///
UINT16 ClockOffset;
///
/// Bluetooth RSSI. See Bluetooth specification for detail.
///
UINT8 RSSI;
///
/// Bluetooth ExtendedInquiryResponse. See Bluetooth specification for detail.
///
UINT8 ExtendedInquiryResponse[240];
} EFI_BLUETOOTH_DEVICE_INFO;
/**
Get Bluetooth device information.
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[out] DeviceInfoSize A pointer to the size, in bytes, of the DeviceInfo buffer.
@param[out] DeviceInfo A pointer to a callee allocated buffer that returns Bluetooth device information.
@retval EFI_SUCCESS The Bluetooth device information is returned successfully.
@retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the Bluetooth device information.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_GET_DEVICE_INFO)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
OUT UINTN *DeviceInfoSize,
OUT VOID **DeviceInfo
);
/**
Get Bluetooth SDP information.
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[out] SdpInfoSize A pointer to the size, in bytes, of the SdpInfo buffer.
@param[out] SdpInfo A pointer to a callee allocated buffer that returns Bluetooth SDP information.
@retval EFI_SUCCESS The Bluetooth device information is returned successfully.
@retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the Bluetooth SDP information.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_GET_SDP_INFO)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
OUT UINTN *SdpInfoSize,
OUT VOID **SdpInfo
);
/**
Send L2CAP message (including L2CAP header).
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[in, out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer.
On output, indicates the amount of data actually transferred.
@param[in] Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer.
@param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in
milliseconds. If Timeout is 0, then the caller must wait for the function to be completed
until EFI_SUCCESS or EFI_DEVICE_ERROR is returned.
@retval EFI_SUCCESS The L2CAP message is sent successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- BufferSize is NULL.
- *BufferSize is 0.
- Buffer is NULL.
@retval EFI_TIMEOUT Sending L2CAP message fail due to timeout.
@retval EFI_DEVICE_ERROR Sending L2CAP message fail due to host controller or device error.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_L2CAP_RAW_SEND)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
IN OUT UINTN *BufferSize,
IN VOID *Buffer,
IN UINTN Timeout
);
/**
Receive L2CAP message (including L2CAP header).
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[in] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer.
On output, indicates the amount of data actually transferred.
@param[out] Buffer A pointer to the buffer of data that will be received from Bluetooth L2CAP layer.
@param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in
milliseconds. If Timeout is 0, then the caller must wait for the function to be completed
until EFI_SUCCESS or EFI_DEVICE_ERROR is returned.
@retval EFI_SUCCESS The L2CAP message is received successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- BufferSize is NULL.
- *BufferSize is 0.
- Buffer is NULL.
@retval EFI_TIMEOUT Receiving L2CAP message fail due to timeout.
@retval EFI_DEVICE_ERROR Receiving L2CAP message fail due to host controller or device error.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_L2CAP_RAW_RECEIVE)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
IN OUT UINTN *BufferSize,
OUT VOID *Buffer,
IN UINTN Timeout
);
/**
Callback function, it is called when asynchronous transfer is completed.
@param[in] ChannelID Bluetooth L2CAP message channel ID.
@param[in] Data Data received via asynchronous transfer.
@param[in] DataLength The length of Data in bytes, received via asynchronous transfer.
@param[in] Context Context passed from asynchronous transfer request.
@retval EFI_SUCCESS The callback function complete successfully.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_ASYNC_FUNC_CALLBACK) (
IN UINT16 ChannelID,
IN VOID *Data,
IN UINTN DataLength,
IN VOID *Context
);
/**
Receive L2CAP message (including L2CAP header) in non-blocking way.
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[in] IsNewTransfer If TRUE, a new transfer will be submitted. If FALSE, the request is deleted.
@param[in] PollingInterval Indicates the periodic rate, in milliseconds, that the transfer is to be executed.
@param[in] DataLength Specifies the length, in bytes, of the data to be received.
@param[in] Callback The callback function. This function is called if the asynchronous transfer is
completed.
@param[in] Context Data passed into Callback function. This is optional parameter and may be NULL.
@retval EFI_SUCCESS The L2CAP asynchronous receive request is submitted successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- DataLength is 0.
- If IsNewTransfer is TRUE, and an asynchronous receive request already exists.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_L2CAP_RAW_ASYNC_RECEIVE)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
IN BOOLEAN IsNewTransfer,
IN UINTN PollingInterval,
IN UINTN DataLength,
IN EFI_BLUETOOTH_IO_ASYNC_FUNC_CALLBACK Callback,
IN VOID *Context
);
/**
Send L2CAP message (excluding L2CAP header) to a specific channel.
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[in] Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to send.
@param[in, out] BufferSize On input, indicates the size, in bytes, of the data buffer specified by Buffer.
On output, indicates the amount of data actually transferred.
@param[in] Buffer A pointer to the buffer of data that will be transmitted to Bluetooth L2CAP layer.
@param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in
milliseconds. If Timeout is 0, then the caller must wait for the function to be completed
until EFI_SUCCESS or EFI_DEVICE_ERROR is returned.
@retval EFI_SUCCESS The L2CAP message is sent successfully.
@retval EFI_NOT_FOUND Handle is invalid or not found.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- BufferSize is NULL.
- *BufferSize is 0.
- Buffer is NULL.
@retval EFI_TIMEOUT Sending L2CAP message fail due to timeout.
@retval EFI_DEVICE_ERROR Sending L2CAP message fail due to host controller or device error.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_L2CAP_SEND)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
IN EFI_HANDLE Handle,
IN OUT UINTN *BufferSize,
IN VOID *Buffer,
IN UINTN Timeout
);
/**
Receive L2CAP message (excluding L2CAP header) from a specific channel.
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[in] Handle A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel to receive.
@param[out] BufferSize Indicates the size, in bytes, of the data buffer specified by Buffer.
@param[out] Buffer A pointer to the buffer of data that will be received from Bluetooth L2CAP layer.
@param[in] Timeout Indicating the transfer should be completed within this time frame. The units are in
milliseconds. If Timeout is 0, then the caller must wait for the function to be completed
until EFI_SUCCESS or EFI_DEVICE_ERROR is returned.
@retval EFI_SUCCESS The L2CAP message is received successfully.
@retval EFI_NOT_FOUND Handle is invalid or not found.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- BufferSize is NULL.
- *BufferSize is 0.
- Buffer is NULL.
@retval EFI_TIMEOUT Receiving L2CAP message fail due to timeout.
@retval EFI_DEVICE_ERROR Receiving L2CAP message fail due to host controller or device error.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_L2CAP_RECEIVE)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
IN EFI_HANDLE Handle,
OUT UINTN *BufferSize,
OUT VOID **Buffer,
IN UINTN Timeout
);
/**
Callback function, it is called when asynchronous transfer is completed.
@param[in] Data Data received via asynchronous transfer.
@param[in] DataLength The length of Data in bytes, received via asynchronous transfer.
@param[in] Context Context passed from asynchronous transfer request.
@retval EFI_SUCCESS The callback function complete successfully.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK) (
IN VOID *Data,
IN UINTN DataLength,
IN VOID *Context
);
/**
Receive L2CAP message (excluding L2CAP header) in non-blocking way from a specific channel.
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[in] Handel A handle created by EFI_BLUETOOTH_IO_PROTOCOL.L2CapConnect indicates which channel
to receive.
@param[in] Callback The callback function. This function is called if the asynchronous transfer is
completed.
@param[in] Context Data passed into Callback function. This is optional parameter and may be NULL.
@retval EFI_SUCCESS The L2CAP asynchronous receive request is submitted successfully.
@retval EFI_NOT_FOUND Handle is invalid or not found.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- DataLength is 0.
- If an asynchronous receive request already exists on same Handle.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_L2CAP_ASYNC_RECEIVE)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
IN EFI_HANDLE Handle,
IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback,
IN VOID* Context
);
/**
Do L2CAP connection.
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[out] Handel A handle to indicate this L2CAP connection.
@param[in] Psm Bluetooth PSM. See Bluetooth specification for detail.
@param[in] Mtu Bluetooth MTU. See Bluetooth specification for detail.
@param[in] Callback The callback function. This function is called whenever there is message received
in this channel.
@param[in] Context Data passed into Callback function. This is optional parameter and may be NULL.
@retval EFI_SUCCESS The Bluetooth L2CAP layer connection is created successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
- Handle is NULL.
@retval EFI_DEVICE_ERROR A hardware error occurred trying to do Bluetooth L2CAP connection.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_L2CAP_CONNECT)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
OUT EFI_HANDLE *Handle,
IN UINT16 Psm,
IN UINT16 Mtu,
IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback,
IN VOID *Context
);
/**
Do L2CAP disconnection.
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[in] Handel A handle to indicate this L2CAP connection.
@retval EFI_SUCCESS The Bluetooth L2CAP layer is disconnected successfully.
@retval EFI_NOT_FOUND Handle is invalid or not found.
@retval EFI_DEVICE_ERROR A hardware error occurred trying to do Bluetooth L2CAP disconnection.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_L2CAP_DISCONNECT)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
IN EFI_HANDLE Handle
);
/**
Register L2CAP callback function for special channel.
@param[in] This Pointer to the EFI_BLUETOOTH_IO_PROTOCOL instance.
@param[out] Handel A handle to indicate this L2CAP connection.
@param[in] Psm Bluetooth PSM. See Bluetooth specification for detail.
@param[in] Mtu Bluetooth MTU. See Bluetooth specification for detail.
@param[in] Callback The callback function. This function is called whenever there is message received
in this channel. NULL means unregister.
@param[in] Context Data passed into Callback function. This is optional parameter and may be NULL.
@retval EFI_SUCCESS The Bluetooth L2CAP callback function is registered successfully.
@retval EFI_ALREADY_STARTED The callback function already exists when register.
@retval EFI_NOT_FOUND The callback function does not exist when unregister.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_BLUETOOTH_IO_L2CAP_REGISTER_SERVICE)(
IN EFI_BLUETOOTH_IO_PROTOCOL *This,
OUT EFI_HANDLE *Handle,
IN UINT16 Psm,
IN UINT16 Mtu,
IN EFI_BLUETOOTH_IO_CHANNEL_SERVICE_CALLBACK Callback,
IN VOID *Context
);
///
/// This protocol provides service for Bluetooth L2CAP (Logical Link Control and Adaptation Protocol)
/// and SDP (Service Discovery Protocol).
///
struct _EFI_BLUETOOTH_IO_PROTOCOL {
EFI_BLUETOOTH_IO_GET_DEVICE_INFO GetDeviceInfo;
EFI_BLUETOOTH_IO_GET_SDP_INFO GetSdpInfo;
EFI_BLUETOOTH_IO_L2CAP_RAW_SEND L2CapRawSend;
EFI_BLUETOOTH_IO_L2CAP_RAW_RECEIVE L2CapRawReceive;
EFI_BLUETOOTH_IO_L2CAP_RAW_ASYNC_RECEIVE L2CapRawAsyncReceive;
EFI_BLUETOOTH_IO_L2CAP_SEND L2CapSend;
EFI_BLUETOOTH_IO_L2CAP_RECEIVE L2CapReceive;
EFI_BLUETOOTH_IO_L2CAP_ASYNC_RECEIVE L2CapAsyncReceive;
EFI_BLUETOOTH_IO_L2CAP_CONNECT L2CapConnect;
EFI_BLUETOOTH_IO_L2CAP_DISCONNECT L2CapDisconnect;
EFI_BLUETOOTH_IO_L2CAP_REGISTER_SERVICE L2CapRegisterService;
};
extern EFI_GUID gEfiBluetoothIoServiceBindingProtocolGuid;
extern EFI_GUID gEfiBluetoothIoProtocolGuid;
#endif
|
