High level Bluetooth Low Energy API and radio abstraction layer
Fork of BLE_API by
ble/GattCallbackParamTypes.h@1183:1589830dbdb7, 2016-04-06 (annotated)
- Committer:
- vcoubard
- Date:
- Wed Apr 06 19:15:36 2016 +0100
- Revision:
- 1183:1589830dbdb7
- Parent:
- 1179:4ab722f8dca0
Synchronized with git rev 44cc6871
Author: Andres Amaya Garcia
Merge branch 'develop' into fix-doxy-warnings
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
vcoubard | 1162:2cb412b35d95 | 1 | /* mbed Microcontroller Library |
vcoubard | 1162:2cb412b35d95 | 2 | * Copyright (c) 2006-2013 ARM Limited |
vcoubard | 1162:2cb412b35d95 | 3 | * |
vcoubard | 1162:2cb412b35d95 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
vcoubard | 1162:2cb412b35d95 | 5 | * you may not use this file except in compliance with the License. |
vcoubard | 1162:2cb412b35d95 | 6 | * You may obtain a copy of the License at |
vcoubard | 1162:2cb412b35d95 | 7 | * |
vcoubard | 1162:2cb412b35d95 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
vcoubard | 1162:2cb412b35d95 | 9 | * |
vcoubard | 1162:2cb412b35d95 | 10 | * Unless required by applicable law or agreed to in writing, software |
vcoubard | 1162:2cb412b35d95 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
vcoubard | 1162:2cb412b35d95 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
vcoubard | 1162:2cb412b35d95 | 13 | * See the License for the specific language governing permissions and |
vcoubard | 1162:2cb412b35d95 | 14 | * limitations under the License. |
vcoubard | 1162:2cb412b35d95 | 15 | */ |
vcoubard | 1162:2cb412b35d95 | 16 | |
vcoubard | 1162:2cb412b35d95 | 17 | #ifndef __GATT_CALLBACK_PARAM_TYPES_H__ |
vcoubard | 1162:2cb412b35d95 | 18 | #define __GATT_CALLBACK_PARAM_TYPES_H__ |
vcoubard | 1162:2cb412b35d95 | 19 | |
vcoubard | 1162:2cb412b35d95 | 20 | struct GattWriteCallbackParams { |
vcoubard | 1183:1589830dbdb7 | 21 | /** |
vcoubard | 1183:1589830dbdb7 | 22 | * Enumeration for write operations. |
vcoubard | 1183:1589830dbdb7 | 23 | */ |
vcoubard | 1162:2cb412b35d95 | 24 | enum WriteOp_t { |
vcoubard | 1162:2cb412b35d95 | 25 | OP_INVALID = 0x00, /**< Invalid operation. */ |
vcoubard | 1162:2cb412b35d95 | 26 | OP_WRITE_REQ = 0x01, /**< Write request. */ |
vcoubard | 1162:2cb412b35d95 | 27 | OP_WRITE_CMD = 0x02, /**< Write command. */ |
vcoubard | 1162:2cb412b35d95 | 28 | OP_SIGN_WRITE_CMD = 0x03, /**< Signed write command. */ |
vcoubard | 1162:2cb412b35d95 | 29 | OP_PREP_WRITE_REQ = 0x04, /**< Prepare write request. */ |
vcoubard | 1162:2cb412b35d95 | 30 | OP_EXEC_WRITE_REQ_CANCEL = 0x05, /**< Execute write request: cancel all prepared writes. */ |
vcoubard | 1162:2cb412b35d95 | 31 | OP_EXEC_WRITE_REQ_NOW = 0x06, /**< Execute write request: immediately execute all prepared writes. */ |
vcoubard | 1162:2cb412b35d95 | 32 | }; |
vcoubard | 1162:2cb412b35d95 | 33 | |
vcoubard | 1183:1589830dbdb7 | 34 | Gap::Handle_t connHandle; /**< The handle of the connection that triggered the event */ |
vcoubard | 1183:1589830dbdb7 | 35 | GattAttribute::Handle_t handle; /**< Attribute Handle to which the write operation applies. */ |
vcoubard | 1183:1589830dbdb7 | 36 | WriteOp_t writeOp; /**< Type of write operation. */ |
vcoubard | 1183:1589830dbdb7 | 37 | uint16_t offset; /**< Offset for the write operation. */ |
vcoubard | 1183:1589830dbdb7 | 38 | uint16_t len; /**< Length (in bytes) of the data to write. */ |
vcoubard | 1183:1589830dbdb7 | 39 | /** |
vcoubard | 1183:1589830dbdb7 | 40 | * Pointer to the data to write. |
vcoubard | 1183:1589830dbdb7 | 41 | * |
vcoubard | 1183:1589830dbdb7 | 42 | * @note Data might not persist beyond the callback; make a local copy if |
vcoubard | 1183:1589830dbdb7 | 43 | * needed. |
vcoubard | 1183:1589830dbdb7 | 44 | */ |
vcoubard | 1183:1589830dbdb7 | 45 | const uint8_t *data; |
vcoubard | 1162:2cb412b35d95 | 46 | }; |
vcoubard | 1162:2cb412b35d95 | 47 | |
vcoubard | 1162:2cb412b35d95 | 48 | struct GattReadCallbackParams { |
vcoubard | 1183:1589830dbdb7 | 49 | Gap::Handle_t connHandle; /**< The handle of the connection that triggered the event */ |
vcoubard | 1183:1589830dbdb7 | 50 | GattAttribute::Handle_t handle; /**< Attribute Handle to which the read operation applies. */ |
vcoubard | 1183:1589830dbdb7 | 51 | uint16_t offset; /**< Offset for the read operation. */ |
vcoubard | 1183:1589830dbdb7 | 52 | uint16_t len; /**< Length (in bytes) of the data to read. */ |
vcoubard | 1183:1589830dbdb7 | 53 | /** |
vcoubard | 1183:1589830dbdb7 | 54 | * Pointer to the data read. |
vcoubard | 1183:1589830dbdb7 | 55 | * |
vcoubard | 1183:1589830dbdb7 | 56 | * @note Data might not persist beyond the callback; make a local copy if |
vcoubard | 1183:1589830dbdb7 | 57 | * needed. |
vcoubard | 1183:1589830dbdb7 | 58 | */ |
vcoubard | 1183:1589830dbdb7 | 59 | const uint8_t *data; |
vcoubard | 1162:2cb412b35d95 | 60 | }; |
vcoubard | 1162:2cb412b35d95 | 61 | |
vcoubard | 1162:2cb412b35d95 | 62 | enum GattAuthCallbackReply_t { |
vcoubard | 1162:2cb412b35d95 | 63 | AUTH_CALLBACK_REPLY_SUCCESS = 0x00, /**< Success. */ |
vcoubard | 1162:2cb412b35d95 | 64 | AUTH_CALLBACK_REPLY_ATTERR_INVALID_HANDLE = 0x0101, /**< ATT Error: Invalid attribute handle. */ |
vcoubard | 1162:2cb412b35d95 | 65 | AUTH_CALLBACK_REPLY_ATTERR_READ_NOT_PERMITTED = 0x0102, /**< ATT Error: Read not permitted. */ |
vcoubard | 1162:2cb412b35d95 | 66 | AUTH_CALLBACK_REPLY_ATTERR_WRITE_NOT_PERMITTED = 0x0103, /**< ATT Error: Write not permitted. */ |
vcoubard | 1162:2cb412b35d95 | 67 | AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHENTICATION = 0x0105, /**< ATT Error: Authenticated link required. */ |
vcoubard | 1162:2cb412b35d95 | 68 | AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET = 0x0107, /**< ATT Error: The specified offset was past the end of the attribute. */ |
vcoubard | 1162:2cb412b35d95 | 69 | AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION = 0x0108, /**< ATT Error: Used in ATT as "insufficient authorization". */ |
vcoubard | 1162:2cb412b35d95 | 70 | AUTH_CALLBACK_REPLY_ATTERR_PREPARE_QUEUE_FULL = 0x0109, /**< ATT Error: Used in ATT as "prepare queue full". */ |
vcoubard | 1162:2cb412b35d95 | 71 | AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_FOUND = 0x010A, /**< ATT Error: Used in ATT as "attribute not found". */ |
vcoubard | 1162:2cb412b35d95 | 72 | AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_LONG = 0x010B, /**< ATT Error: Attribute cannot be read or written using read/write blob requests. */ |
vcoubard | 1162:2cb412b35d95 | 73 | AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH = 0x010D, /**< ATT Error: Invalid value size. */ |
vcoubard | 1162:2cb412b35d95 | 74 | AUTH_CALLBACK_REPLY_ATTERR_INSUF_RESOURCES = 0x0111, /**< ATT Error: Encrypted link required. */ |
vcoubard | 1162:2cb412b35d95 | 75 | }; |
vcoubard | 1162:2cb412b35d95 | 76 | |
vcoubard | 1162:2cb412b35d95 | 77 | struct GattWriteAuthCallbackParams { |
vcoubard | 1183:1589830dbdb7 | 78 | Gap::Handle_t connHandle; /**< The handle of the connection that triggered the event */ |
vcoubard | 1183:1589830dbdb7 | 79 | GattAttribute::Handle_t handle; /**< Attribute Handle to which the write operation applies. */ |
vcoubard | 1183:1589830dbdb7 | 80 | uint16_t offset; /**< Offset for the write operation. */ |
vcoubard | 1183:1589830dbdb7 | 81 | uint16_t len; /**< Length of the incoming data. */ |
vcoubard | 1183:1589830dbdb7 | 82 | const uint8_t *data; /**< Incoming data, variable length. */ |
vcoubard | 1183:1589830dbdb7 | 83 | /** |
vcoubard | 1183:1589830dbdb7 | 84 | * This is the out parameter that the callback needs to set to |
vcoubard | 1183:1589830dbdb7 | 85 | * AUTH_CALLBACK_REPLY_SUCCESS for the request to proceed. |
vcoubard | 1183:1589830dbdb7 | 86 | */ |
vcoubard | 1183:1589830dbdb7 | 87 | GattAuthCallbackReply_t authorizationReply; |
vcoubard | 1162:2cb412b35d95 | 88 | }; |
vcoubard | 1162:2cb412b35d95 | 89 | |
vcoubard | 1162:2cb412b35d95 | 90 | struct GattReadAuthCallbackParams { |
vcoubard | 1183:1589830dbdb7 | 91 | Gap::Handle_t connHandle; /**< The handle of the connection that triggered the event */ |
vcoubard | 1183:1589830dbdb7 | 92 | GattAttribute::Handle_t handle; /**< Attribute Handle to which the read operation applies. */ |
vcoubard | 1183:1589830dbdb7 | 93 | uint16_t offset; /**< Offset for the read operation. */ |
vcoubard | 1183:1589830dbdb7 | 94 | uint16_t len; /**< Optional: new length of the outgoing data. */ |
vcoubard | 1183:1589830dbdb7 | 95 | uint8_t *data; /**< Optional: new outgoing data. Leave at NULL if data is unchanged. */ |
vcoubard | 1183:1589830dbdb7 | 96 | /** |
vcoubard | 1183:1589830dbdb7 | 97 | * This is the out parameter that the callback needs to set to |
vcoubard | 1183:1589830dbdb7 | 98 | * AUTH_CALLBACK_REPLY_SUCCESS for the request to proceed. |
vcoubard | 1183:1589830dbdb7 | 99 | */ |
vcoubard | 1183:1589830dbdb7 | 100 | GattAuthCallbackReply_t authorizationReply; |
vcoubard | 1162:2cb412b35d95 | 101 | }; |
vcoubard | 1162:2cb412b35d95 | 102 | |
vcoubard | 1183:1589830dbdb7 | 103 | /** |
vcoubard | 1183:1589830dbdb7 | 104 | * For encapsulating handle-value update events (notifications or indications) |
vcoubard | 1183:1589830dbdb7 | 105 | * generated at the remote server. |
vcoubard | 1183:1589830dbdb7 | 106 | */ |
vcoubard | 1162:2cb412b35d95 | 107 | struct GattHVXCallbackParams { |
vcoubard | 1183:1589830dbdb7 | 108 | Gap::Handle_t connHandle; /**< The handle of the connection that triggered the event */ |
vcoubard | 1183:1589830dbdb7 | 109 | GattAttribute::Handle_t handle; /**< Attribute Handle to which the HVx operation applies. */ |
vcoubard | 1183:1589830dbdb7 | 110 | HVXType_t type; /**< Indication or Notification, see HVXType_t. */ |
vcoubard | 1183:1589830dbdb7 | 111 | uint16_t len; /**< Attribute data length. */ |
vcoubard | 1183:1589830dbdb7 | 112 | const uint8_t *data; /**< Attribute data, variable length. */ |
vcoubard | 1162:2cb412b35d95 | 113 | }; |
vcoubard | 1162:2cb412b35d95 | 114 | |
rgrover1 | 716:11b41f651697 | 115 | #endif /*__GATT_CALLBACK_PARAM_TYPES_H__*/ |