Lancaster University / BLE_API

Lancaster University's fork of the mbed BLE API. Lives on github, https://github.com/lancaster-university/BLE_API

Dependents:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

ble/GattCallbackParamTypes.h@1140:dd2f69fad8c6, 2016-04-06 (annotated)

Committer:
LancasterUniversity
Date:
Wed Apr 06 18:40:40 2016 +0100
Revision:
1140:dd2f69fad8c6
Parent:
1048:efb29faf12fc 
Synchronized with git rev bbc2dc58

Author: Joe Finney

microbit: Additional callback to indicate to applications when System

Attributes require initialisation from persistent storage.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 716:11b41f651697 1 /* mbed Microcontroller Library
rgrover1 716:11b41f651697 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 716:11b41f651697 3 *
rgrover1 716:11b41f651697 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 716:11b41f651697 5 * you may not use this file except in compliance with the License.
rgrover1 716:11b41f651697 6 * You may obtain a copy of the License at
rgrover1 716:11b41f651697 7 *
rgrover1 716:11b41f651697 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 716:11b41f651697 9 *
rgrover1 716:11b41f651697 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 716:11b41f651697 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 716:11b41f651697 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 716:11b41f651697 13 * See the License for the specific language governing permissions and
rgrover1 716:11b41f651697 14 * limitations under the License.
rgrover1 716:11b41f651697 15 */
rgrover1 716:11b41f651697 16
rgrover1 716:11b41f651697 17 #ifndef __GATT_CALLBACK_PARAM_TYPES_H__
rgrover1 716:11b41f651697 18 #define __GATT_CALLBACK_PARAM_TYPES_H__
rgrover1 716:11b41f651697 19
rgrover1 716:11b41f651697 20 struct GattWriteCallbackParams {
rgrover1 716:11b41f651697 21 enum WriteOp_t {
vcoubard 1048:efb29faf12fc 22 OP_INVALID = 0x00, /**< Invalid operation. */
vcoubard 1048:efb29faf12fc 23 OP_WRITE_REQ = 0x01, /**< Write request. */
vcoubard 1048:efb29faf12fc 24 OP_WRITE_CMD = 0x02, /**< Write command. */
vcoubard 1048:efb29faf12fc 25 OP_SIGN_WRITE_CMD = 0x03, /**< Signed write command. */
vcoubard 1048:efb29faf12fc 26 OP_PREP_WRITE_REQ = 0x04, /**< Prepare write request. */
vcoubard 1048:efb29faf12fc 27 OP_EXEC_WRITE_REQ_CANCEL = 0x05, /**< Execute write request: cancel all prepared writes. */
vcoubard 1048:efb29faf12fc 28 OP_EXEC_WRITE_REQ_NOW = 0x06, /**< Execute write request: immediately execute all prepared writes. */
rgrover1 716:11b41f651697 29 };
rgrover1 716:11b41f651697 30
rgrover1 788:89433790768b 31 Gap::Handle_t connHandle;
rgrover1 716:11b41f651697 32 GattAttribute::Handle_t handle;
vcoubard 1048:efb29faf12fc 33 WriteOp_t writeOp; /**< Type of write operation. */
rgrover1 716:11b41f651697 34 uint16_t offset; /**< Offset for the write operation. */
rgrover1 716:11b41f651697 35 uint16_t len;
vcoubard 1048:efb29faf12fc 36 const uint8_t *data; /* @note: Data might not persist beyond the callback; make a local copy if needed. */
rgrover1 716:11b41f651697 37 };
rgrover1 716:11b41f651697 38
rgrover1 716:11b41f651697 39 struct GattReadCallbackParams {
rgrover1 788:89433790768b 40 Gap::Handle_t connHandle;
rgrover1 716:11b41f651697 41 GattAttribute::Handle_t handle;
rgrover1 716:11b41f651697 42 uint16_t offset; /**< Offset for the read operation. */
rgrover1 716:11b41f651697 43 uint16_t len;
vcoubard 1048:efb29faf12fc 44 const uint8_t *data; /* @note: Data might not persist beyond the callback; make a local copy if needed. */
rgrover1 716:11b41f651697 45 };
rgrover1 716:11b41f651697 46
LancasterUniversity 1140:dd2f69fad8c6 47 struct GattSysAttrMissingCallbackParams {
LancasterUniversity 1140:dd2f69fad8c6 48 Gap::Handle_t connHandle;
LancasterUniversity 1140:dd2f69fad8c6 49 };
LancasterUniversity 1140:dd2f69fad8c6 50
rgrover1 716:11b41f651697 51 enum GattAuthCallbackReply_t {
rgrover1 789:e33a8b853eb8 52 AUTH_CALLBACK_REPLY_SUCCESS = 0x00, /**< Success. */
vcoubard 1048:efb29faf12fc 53 AUTH_CALLBACK_REPLY_ATTERR_INVALID_HANDLE = 0x0101, /**< ATT Error: Invalid attribute handle. */
rgrover1 789:e33a8b853eb8 54 AUTH_CALLBACK_REPLY_ATTERR_READ_NOT_PERMITTED = 0x0102, /**< ATT Error: Read not permitted. */
rgrover1 789:e33a8b853eb8 55 AUTH_CALLBACK_REPLY_ATTERR_WRITE_NOT_PERMITTED = 0x0103, /**< ATT Error: Write not permitted. */
rgrover1 789:e33a8b853eb8 56 AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHENTICATION = 0x0105, /**< ATT Error: Authenticated link required. */
vcoubard 1048:efb29faf12fc 57 AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET = 0x0107, /**< ATT Error: The specified offset was past the end of the attribute. */
vcoubard 1048:efb29faf12fc 58 AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION = 0x0108, /**< ATT Error: Used in ATT as "insufficient authorization". */
vcoubard 1048:efb29faf12fc 59 AUTH_CALLBACK_REPLY_ATTERR_PREPARE_QUEUE_FULL = 0x0109, /**< ATT Error: Used in ATT as "prepare queue full". */
vcoubard 1048:efb29faf12fc 60 AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_FOUND = 0x010A, /**< ATT Error: Used in ATT as "attribute not found". */
rgrover1 789:e33a8b853eb8 61 AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_LONG = 0x010B, /**< ATT Error: Attribute cannot be read or written using read/write blob requests. */
rgrover1 716:11b41f651697 62 AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH = 0x010D, /**< ATT Error: Invalid value size. */
rgrover1 789:e33a8b853eb8 63 AUTH_CALLBACK_REPLY_ATTERR_INSUF_RESOURCES = 0x0111, /**< ATT Error: Encrypted link required. */
rgrover1 716:11b41f651697 64 };
rgrover1 716:11b41f651697 65
rgrover1 716:11b41f651697 66 struct GattWriteAuthCallbackParams {
rgrover1 788:89433790768b 67 Gap::Handle_t connHandle;
rgrover1 716:11b41f651697 68 GattAttribute::Handle_t handle;
rgrover1 716:11b41f651697 69 uint16_t offset; /**< Offset for the write operation. */
rgrover1 716:11b41f651697 70 uint16_t len; /**< Length of the incoming data. */
rgrover1 716:11b41f651697 71 const uint8_t *data; /**< Incoming data, variable length. */
vcoubard 1048:efb29faf12fc 72 GattAuthCallbackReply_t authorizationReply; /* This is the out parameter that the callback
vcoubard 1048:efb29faf12fc 73 * needs to set to AUTH_CALLBACK_REPLY_SUCCESS
vcoubard 1048:efb29faf12fc 74 * for the request to proceed. */
rgrover1 716:11b41f651697 75 };
rgrover1 716:11b41f651697 76
rgrover1 716:11b41f651697 77 struct GattReadAuthCallbackParams {
rgrover1 788:89433790768b 78 Gap::Handle_t connHandle;
rgrover1 716:11b41f651697 79 GattAttribute::Handle_t handle;
rgrover1 716:11b41f651697 80 uint16_t offset; /**< Offset for the read operation. */
rgrover1 716:11b41f651697 81 uint16_t len; /**< Optional: new length of the outgoing data. */
rgrover1 716:11b41f651697 82 uint8_t *data; /**< Optional: new outgoing data. Leave at NULL if data is unchanged. */
vcoubard 1048:efb29faf12fc 83 GattAuthCallbackReply_t authorizationReply; /* This is the out parameter that the callback
vcoubard 1048:efb29faf12fc 84 * needs to set to AUTH_CALLBACK_REPLY_SUCCESS
vcoubard 1048:efb29faf12fc 85 * for the request to proceed. */
rgrover1 716:11b41f651697 86 };
rgrover1 716:11b41f651697 87
rgrover1 737:79d95f9b93be 88 /* For encapsulating handle-value update events (notifications or indications) generated at the remote server. */
rgrover1 737:79d95f9b93be 89 struct GattHVXCallbackParams {
rgrover1 788:89433790768b 90 Gap::Handle_t connHandle;
rgrover1 737:79d95f9b93be 91 GattAttribute::Handle_t handle; /**< Attribute Handle to which the HVx operation applies. */
rgrover1 737:79d95f9b93be 92 HVXType_t type; /**< Indication or Notification, see @ref HVXType_t. */
rgrover1 737:79d95f9b93be 93 uint16_t len; /**< Attribute data length. */
rgrover1 737:79d95f9b93be 94 const uint8_t *data; /**< Attribute data, variable length. */
rgrover1 737:79d95f9b93be 95 };
rgrover1 737:79d95f9b93be 96
rgrover1 716:11b41f651697 97 #endif /*__GATT_CALLBACK_PARAM_TYPES_H__*/