TI BLE5-Stack API Documentation  1.01.01.00
att.h
Go to the documentation of this file.
1 /******************************************************************************
2 
3  Group: WCS, BTS
4  $Target Device: DEVICES $
5 
6  ******************************************************************************
7  $License: TISD 2009 $
8  ******************************************************************************
9  $Release Name: PACKAGE NAME $
10  $Release Date: PACKAGE RELEASE DATE $
11  *****************************************************************************/
12 
24 #ifndef ATT_H
25 #define ATT_H
26 
27 #ifdef __cplusplus
28 extern "C"
29 {
30 #endif
31 
32 /*********************************************************************
33  * INCLUDES
34  */
35 #include "bcomdef.h"
36 #include "osal.h"
37 
38 #include "l2cap.h"
39 
40 /*********************************************************************
41  * CONSTANTS
42  */
43 
58 #define ATT_MTU_SIZE L2CAP_MTU_SIZE
59 #define ATT_MAX_MTU_SIZE (255-L2CAP_HDR_SIZE)
60 
66 #define ATT_ERROR_RSP 0x01
67 #define ATT_EXCHANGE_MTU_REQ 0x02
68 #define ATT_EXCHANGE_MTU_RSP 0x03
69 #define ATT_FIND_INFO_REQ 0x04
70 #define ATT_FIND_INFO_RSP 0x05
71 #define ATT_FIND_BY_TYPE_VALUE_REQ 0x06
72 #define ATT_FIND_BY_TYPE_VALUE_RSP 0x07
73 #define ATT_READ_BY_TYPE_REQ 0x08
74 #define ATT_READ_BY_TYPE_RSP 0x09
75 #define ATT_READ_REQ 0x0a
76 #define ATT_READ_RSP 0x0b
77 #define ATT_READ_BLOB_REQ 0x0c
78 #define ATT_READ_BLOB_RSP 0x0d
79 #define ATT_READ_MULTI_REQ 0x0e
80 #define ATT_READ_MULTI_RSP 0x0f
81 #define ATT_READ_BY_GRP_TYPE_REQ 0x10
82 #define ATT_READ_BY_GRP_TYPE_RSP 0x11
83 #define ATT_WRITE_REQ 0x12
84 #define ATT_WRITE_RSP 0x13
85 #define ATT_PREPARE_WRITE_REQ 0x16
86 #define ATT_PREPARE_WRITE_RSP 0x17
87 #define ATT_EXECUTE_WRITE_REQ 0x18
88 #define ATT_EXECUTE_WRITE_RSP 0x19
89 #define ATT_HANDLE_VALUE_NOTI 0x1b
90 #define ATT_HANDLE_VALUE_IND 0x1d
91 #define ATT_HANDLE_VALUE_CFM 0x1e
92 
93 #define ATT_WRITE_CMD 0x52
94 #define ATT_SIGNED_WRITE_CMD 0xD2
95 
101 #define ATT_TRANSACTION_READY_EVENT 0x7D
102 #define ATT_FLOW_CTRL_VIOLATED_EVENT 0x7E
103 #define ATT_MTU_UPDATED_EVENT 0x7F
104 
111 #define ATT_METHOD_BITS 0x3f
112 #define ATT_CMD_FLAG_BIT 0x40
113 #define ATT_AUTHEN_SIG_FLAG_BIT 0x80
114 #define ATT_BT_UUID_SIZE 2
115 #define ATT_UUID_SIZE 16
116 #define ATT_MSG_TIMEOUT 30
117 
124 #define ATT_SIG_NOT_INCLUDED 0x00
125 #define ATT_SIG_VALID 0x01
126 #define ATT_SIG_INVALID 0x02
127 
129 /*********************************************************************
130  * Error Response: Error Code
131  */
132 
137 #define ATT_ERR_INVALID_HANDLE 0x01
138 #define ATT_ERR_READ_NOT_PERMITTED 0x02
139 #define ATT_ERR_WRITE_NOT_PERMITTED 0x03
140 #define ATT_ERR_INVALID_PDU 0x04
141 #define ATT_ERR_INSUFFICIENT_AUTHEN 0x05
142 #define ATT_ERR_UNSUPPORTED_REQ 0x06
143 #define ATT_ERR_INVALID_OFFSET 0x07
144 #define ATT_ERR_INSUFFICIENT_AUTHOR 0x08
145 #define ATT_ERR_PREPARE_QUEUE_FULL 0x09
146 #define ATT_ERR_ATTR_NOT_FOUND 0x0a
147 #define ATT_ERR_ATTR_NOT_LONG 0x0b
148 #define ATT_ERR_INSUFFICIENT_KEY_SIZE 0x0c
149 #define ATT_ERR_INVALID_VALUE_SIZE 0x0d
150 #define ATT_ERR_UNLIKELY 0x0e
151 #define ATT_ERR_INSUFFICIENT_ENCRYPT 0x0f
152 #define ATT_ERR_UNSUPPORTED_GRP_TYPE 0x10
153 #define ATT_ERR_INSUFFICIENT_RESOURCES 0x11
154 
155 /*** Reserved for future use: 0x12 - 0x7F ***/
156 
157 /*** Application error code defined by a higher layer specification: 0x80-0x9F ***/
158 
159 #define ATT_ERR_INVALID_VALUE 0x80
160 
162 /*********************************************************************
163  * Find Information Response: UUID Format
164  */
165 #define ATT_HANDLE_BT_UUID_TYPE 0x01
166 #define ATT_HANDLE_UUID_TYPE 0x02
167 
168 /*********************************************************************
169  * Read Multiple Request: Handles
170  */
171 #define ATT_MIN_NUM_HANDLES 2
172 
173 /*********************************************************************
174  * Execute Write Request: Flags
175  */
176 #define ATT_CANCEL_PREPARED_WRITES 0x00
177 #define ATT_WRITE_PREPARED_VALUES 0x01
178 
179 #if defined ( TESTMODES )
180  #define ATT_TESTMODE_OFF 0
182  #define ATT_TESTMODE_UNAUTHEN_SIG 1
183 #endif
184 
189 #define ATT_OPCODE_SIZE 1
190 #define ATT_EXCHANGE_MTU_REQ_SIZE 2
191 #define ATT_EXCHANGE_MTU_RSP_SIZE 2
192 #define ATT_ERROR_RSP_SIZE 4
193 #define ATT_FIND_INFO_REQ_FIXED_SIZE 4
194 #define ATT_FIND_INFO_RSP_FIXED_SIZE 1
195 #define ATT_FIND_INFO_RSP_HDR_SIZE ( ATT_OPCODE_SIZE + ATT_FIND_INFO_RSP_FIXED_SIZE )
196 #define ATT_FIND_BY_TYPE_VALUE_REQ_FIXED_SIZE 6
197 #define ATT_FIND_BY_TYPE_VALUE_REQ_HDR_SIZE ( ATT_OPCODE_SIZE + ATT_FIND_BY_TYPE_VALUE_REQ_FIXED_SIZE )
198 #define ATT_READ_BY_TYPE_REQ_FIXED_SIZE 4
199 #define ATT_READ_BY_TYPE_REQ_HDR_SIZE ( ATT_OPCODE_SIZE + ATT_READ_BY_TYPE_REQ_FIXED_SIZE )
200 #define ATT_READ_BY_TYPE_RSP_FIXED_SIZE 1
201 #define ATT_READ_BY_TYPE_RSP_HDR_SIZE ( ATT_OPCODE_SIZE + ATT_READ_BY_TYPE_RSP_FIXED_SIZE )
202 #define ATT_READ_REQ_SIZE 2
203 #define ATT_READ_BY_GRP_TYPE_RSP_FIXED_SIZE 1
204 #define ATT_READ_BY_GRP_TYPE_RSP_HDR_SIZE ( ATT_OPCODE_SIZE + ATT_READ_BY_GRP_TYPE_RSP_FIXED_SIZE )
205 #define ATT_WRITE_REQ_FIXED_SIZE 2
206 #define ATT_READ_BLOB_REQ_SIZE 4
207 #define ATT_WRITE_REQ_FIXED_SIZE 2
208 #define ATT_WRITE_REQ_HDR_SIZE ( ATT_OPCODE_SIZE + ATT_WRITE_REQ_FIXED_SIZE )
209 #define ATT_PREPARE_WRITE_REQ_FIXED_SIZE 4
210 #define ATT_PREPARE_WRITE_REQ_HDR_SIZE ( ATT_OPCODE_SIZE + ATT_PREPARE_WRITE_REQ_FIXED_SIZE )
211 #define ATT_PREPARE_WRITE_RSP_FIXED_SIZE 4
212 #define ATT_EXECUTE_WRITE_REQ_SIZE 1
213 #define ATT_HANDLE_VALUE_IND_FIXED_SIZE 2
214 #define ATT_HANDLE_VALUE_IND_HDR_SIZE ( ATT_OPCODE_SIZE + ATT_HANDLE_VALUE_IND_FIXED_SIZE )
215 #define ATT_AUTHEN_SIG_LEN 12
216 
218 /*********************************************************************
219  * VARIABLES
220  */
221 
223 extern CONST uint8 btBaseUUID[ATT_UUID_SIZE];
225 
226 /*********************************************************************
227  * MACROS
228  */
230 #define ATT_WRITE_COMMAND( method, cmd ) ( ( (method) == ATT_WRITE_REQ ) && ( (cmd) == TRUE ) )
231 
232 /*********************************************************************
233  * ATT Find Info Response macros
234  */
235 
237 
238 // Handle and 16-bit Bluetooth UUID pair indexes
239 #define ATT_BT_PAIR_HANDLE_IDX( i ) ( (i) * (2 + ATT_BT_UUID_SIZE) )
240 #define ATT_BT_PAIR_UUID_IDX( i ) ( ATT_BT_PAIR_HANDLE_IDX( (i) ) + 2 )
241 
242 #define ATT_BT_PAIR_HANDLE( info, i ) ( BUILD_UINT16( (info)[ATT_BT_PAIR_HANDLE_IDX((i))], \
243  (info)[ATT_BT_PAIR_HANDLE_IDX((i))+1] ) )
244 #define ATT_BT_PAIR_UUID( info, i ) ( BUILD_UINT16( (info)[ATT_BT_PAIR_UUID_IDX((i))], \
245  (info)[ATT_BT_PAIR_UUID_IDX((i))+1] ) )
246 
247 // Handle and 128-bit UUID pair indexes
248 #define ATT_PAIR_HANDLE_IDX( i ) ( (i) * (2 + ATT_UUID_SIZE) )
249 #define ATT_PAIR_UUID_IDX( i ) ( ATT_PAIR_HANDLE_IDX( (i) ) + 2 )
250 
251 #define ATT_PAIR_HANDLE( info, i ) ( BUILD_UINT16( (info)[ATT_PAIR_HANDLE_IDX((i))], \
252  (info)[ATT_PAIR_HANDLE_IDX((i))+1] ) )
253 
254 /*********************************************************************
255  * ATT Find By Type Value Response macros
256  */
257 // Attribute Handle and Group End Handle pair indexes
258 #define ATT_ATTR_HANDLE_IDX( i ) ( (i) * (2 + 2) )
259 #define ATT_GRP_END_HANDLE_IDX( i ) ( ATT_ATTR_HANDLE_IDX( (i) ) + 2 )
260 
261 #define ATT_ATTR_HANDLE( info, i ) ( BUILD_UINT16( (info)[ATT_ATTR_HANDLE_IDX((i))], \
262  (info)[ATT_ATTR_HANDLE_IDX((i))+1] ) )
263 #define ATT_GRP_END_HANDLE( info, i ) ( BUILD_UINT16( (info)[ATT_GRP_END_HANDLE_IDX((i))], \
264  (info)[ATT_GRP_END_HANDLE_IDX((i))+1] ) )
265 
266 /*********************************************************************
267  * ATT Read Multiple Request macros
268  */
269 // Attribute Handle index
270 #define ATT_HANDLE_IDX( i ) ( (i) * 2 )
271 
272 #define ATT_HANDLE( handles, i ) ( BUILD_UINT16( (handles)[ATT_HANDLE_IDX((i))], \
273  (handles)[ATT_HANDLE_IDX((i))+1] ) )
274 
276 
279 /*********************************************************************
280  * TYPEDEFS
281  */
282 
288 typedef struct
290 {
291  uint8 sig;
292  uint8 cmd;
293  uint8 method;
294  uint16 len;
295  uint8 *pParams;
296 } attPacket_t;
297 
299 typedef struct
300 {
301  uint8 len;
302  uint8 uuid[ATT_UUID_SIZE];
303 } attAttrType_t;
304 
306 typedef struct
307 {
308  uint8 len;
309  uint8 uuid[ATT_BT_UUID_SIZE];
311 
322 typedef struct
323 {
324  uint8 reqOpcode;
325  uint16 handle;
326  uint8 errCode;
327 } attErrorRsp_t;
328 
334 typedef struct
335 {
336  uint16 clientRxMTU;
338 
344 typedef struct
345 {
346  uint16 serverRxMTU;
348 
354 typedef struct
355 {
356  uint16 startHandle;
357  uint16 endHandle;
359 
361 typedef struct
362 {
363  uint16 handle;
364  uint8 uuid[ATT_BT_UUID_SIZE];
366 
368 typedef struct
369 {
370  uint16 handle;
371  uint8 uuid[ATT_UUID_SIZE];
373 
379 typedef struct
380 {
381  uint16 numInfo;
382  uint8 format;
383  uint8 *pInfo;
385 
391 typedef struct
392 {
393  uint16 startHandle;
394  uint16 endHandle;
396  uint16 len;
397  uint8 *pValue;
399 
401 typedef struct
402 {
403  uint16 handle;
404  uint16 grpEndHandle;
406 
412 typedef struct
413 {
414  uint16 numInfo;
415  uint8 *pHandlesInfo;
417 
423 typedef struct
424 {
425  uint16 startHandle;
426  uint16 endHandle;
429 
435 typedef struct
436 {
437  uint16 numPairs;
438  uint16 len;
439  uint8 *pDataList;
440  uint16 dataLen;
442 
448 typedef struct
449 {
450  uint16 handle;
451 } attReadReq_t;
452 
458 typedef struct
459 {
460  uint16 len;
461  uint8 *pValue;
462 } attReadRsp_t;
463 
469 typedef struct
470 {
471  uint16 handle;
472  uint16 offset;
474 
480 typedef struct
481 {
482  uint16 len;
483  uint8 *pValue;
485 
491 typedef struct
492 {
493  uint8 *pHandles;
494  uint16 numHandles;
496 
502 typedef struct
503 {
504  uint16 len;
505  uint8 *pValues;
507 
513 typedef struct
514 {
515  uint16 startHandle;
516  uint16 endHandle;
519 
525 typedef struct
526 {
527  uint16 numGrps;
528  uint16 len;
529  uint8 *pDataList;
531 
537 typedef struct
538 {
539  uint16 handle;
540  uint16 len;
541  uint8 *pValue;
542  uint8 sig;
543  uint8 cmd;
544 } attWriteReq_t;
545 
551 typedef struct
552 {
553  uint16 handle;
554  uint16 offset;
555  uint16 len;
556  uint8 *pValue;
558 
564 typedef struct
565 {
566  uint16 handle;
567  uint16 offset;
568  uint16 len;
569  uint8 *pValue;
571 
577 typedef struct
578 {
579  uint8 flags;
582 
588 typedef struct
589 {
590  uint16 handle;
591  uint16 len;
592  uint8 *pValue;
594 
600 typedef struct
601 {
602  uint16 handle;
603  uint16 len;
604  uint8 *pValue;
606 
624 typedef struct
625 {
626  uint8 opcode;
629 
640 typedef struct
641 {
642  uint16 MTU;
644 
654 typedef union
655 {
656  // Request messages
668 
669  // Response messages
680 
681  // Indication and Notification messages
684 
685  // Locally-generated event messages
688 } attMsg_t;
689 
692 
694 // Function prototype to notify GATT Server or Client about an outgoing ATT message.
695 typedef void (*attNotifyTxCB_t)( uint16 connHandle, uint8 opcode );
696 
697 /*********************************************************************
698  * VARIABLES
699  */
700 
701 /*********************************************************************
702  * API FUNCTIONS
703  */
704 
705 /*-------------------------------------------------------------------
706  * General Utility APIs
707  */
708 
709 /*
710  * Parse an attribute protocol message.
711  */
712 extern uint8 ATT_ParsePacket( l2capDataEvent_t *pL2capMsg, attPacket_t *pPkt );
713 
714 /*
715  * Compare two UUIDs. The UUIDs are converted if necessary.
716  */
717 extern uint8 ATT_CompareUUID( const uint8 *pUUID1, uint16 len1,
718  const uint8 *pUUID2, uint16 len2 );
719 /*
720  * Convert a 16-bit UUID to 128-bit UUID.
721  */
722 extern uint8 ATT_ConvertUUIDto128( const uint8 *pUUID16, uint8 *pUUID128 );
723 
724 /*
725  * Convert a 128-bit UUID to 16-bit UUID.
726  */
727 extern uint8 ATT_ConvertUUIDto16( const uint8 *pUUID128, uint8 *pUUID16 );
728 
729 
730 /*-------------------------------------------------------------------
731  * Attribute Client Utility APIs
732  */
733 
734 /*
735  * Build Error Response.
736  */
737 extern uint16 ATT_BuildErrorRsp( uint8 *pBuf, uint8 *pMsg );
738 
739 /*
740  * Parse Error Response.
741  */
742 extern bStatus_t ATT_ParseErrorRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
743 
744 /*
745  * Build Exchange MTU Request.
746  */
747 extern uint16 ATT_BuildExchangeMTUReq( uint8 *pBuf, uint8 *pMsg );
748 
749 /*
750  * Build Exchange MTU Response.
751  */
752 extern uint16 ATT_BuildExchangeMTURsp( uint8 *pBuf, uint8 *pMsg );
753 
754 /*
755  * Parse Exchange MTU Response.
756  */
757 extern bStatus_t ATT_ParseExchangeMTURsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
758 
759 /*
760  * Build Find Information Request.
761  */
762 extern uint16 ATT_BuildFindInfoReq( uint8 *pBuf, uint8 *pMsg );
763 
764 /*
765  * Parse Find Information Response.
766  */
767 extern bStatus_t ATT_ParseFindInfoRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
768 
769 /*
770  * Build Find Information Response.
771  */
772 extern uint16 ATT_BuildFindInfoRsp( uint8 *pBuf, uint8 *pMsg );
773 
774 /*
775  * Build Find By Type Value Request.
776  */
777 extern uint16 ATT_BuildFindByTypeValueReq( uint8 *pBuf, uint8 *pMsg );
778 
779 /*
780  * Build Find By Type Value Response.
781  */
782 extern uint16 ATT_BuildFindByTypeValueRsp( uint8 *pBuf, uint8 *pMsg );
783 
784 /*
785  * Parse Find By Type Value Response.
786  */
787 extern bStatus_t ATT_ParseFindByTypeValueRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
788 
789 /*
790  * Build Read By Type Request.
791  */
792 extern uint16 ATT_BuildReadByTypeReq( uint8 *pBuf, uint8 *pMsg );
793 
794 /*
795  * Build Read By Type Response.
796  */
797 extern uint16 ATT_BuildReadByTypeRsp( uint8 *pBuf, uint8 *pMsg );
798 
799 /*
800  * Parse Read By Type Response.
801  */
802 extern bStatus_t ATT_ParseReadByTypeRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
803 
804 /*
805  * Build Read Request.
806  */
807 extern uint16 ATT_BuildReadReq( uint8 *pBuf, uint8 *pMsg );
808 
809 /*
810  * Build Read Response.
811  */
812 extern uint16 ATT_BuildReadRsp( uint8 *pBuf, uint8 *pMsg );
813 
814 /*
815  * Parse Read Response.
816  */
817 extern bStatus_t ATT_ParseReadRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
818 
819 /*
820  * Build Read Blob Request.
821  */
822 extern uint16 ATT_BuildReadBlobReq( uint8 *pBuf, uint8 *pMsg );
823 
824 /*
825  * Build Read Blob Response.
826  */
827 extern uint16 ATT_BuildReadBlobRsp( uint8 *pBuf, uint8 *pMsg );
828 
829 /*
830  * Parse Read Blob Response.
831  */
832 extern bStatus_t ATT_ParseReadBlobRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
833 
834 /*
835  * Build Read Multiple Request.
836  */
837 extern uint16 ATT_BuildReadMultiReq( uint8 *pBuf, uint8 *pMsg );
838 
839 /*
840  * Build Read Multiple Response.
841  */
842 extern uint16 ATT_BuildReadMultiRsp( uint8 *pBuf, uint8 *pMsg );
843 
844 /*
845  * Parse Read Multiple Response.
846  */
847 extern bStatus_t ATT_ParseReadMultiRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
848 
849 /*
850  * Build Read By Group Type Response.
851  */
852 extern uint16 ATT_BuildReadByGrpTypeRsp( uint8 *pBuf, uint8 *pMsg );
853 
854 /*
855  * Parse Read By Group Type Response.
856  */
857 extern bStatus_t ATT_ParseReadByGrpTypeRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
858 
859 /*
860  * Build Write Request.
861  */
862 extern uint16 ATT_BuildWriteReq( uint8 *pBuf, uint8 *pMsg );
863 
864 /*
865  * Parse Write Response.
866  */
867 extern bStatus_t ATT_ParseWriteRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
868 
869 /*
870  * Build Prepare Write Request.
871  */
872 extern uint16 ATT_BuildPrepareWriteReq( uint8 *pBuf, uint8 *pMsg );
873 
874 /*
875  * Build Prepare Write Response.
876  */
877 extern uint16 ATT_BuildPrepareWriteRsp( uint8 *pBuf, uint8 *pMsg );
878 
879 /*
880  * Parse Prepare Write Response.
881  */
882 extern bStatus_t ATT_ParsePrepareWriteRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
883 
884 /*
885  * Build Execute Write Request.
886  */
887 extern uint16 ATT_BuildExecuteWriteReq( uint8 *pBuf, uint8 *pMsg );
888 
889 /*
890  * Parse Execute Write Response.
891  */
892 extern bStatus_t ATT_ParseExecuteWriteRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );
893 
894 /*
895  * Build Handle Value Indication.
896  */
897 extern uint16 ATT_BuildHandleValueInd( uint8 *pBuf, uint8 *pMsg );
898 
899 /*
900  * Parse Handle Value Indication.
901  */
902 extern bStatus_t ATT_ParseHandleValueInd( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
903 
904 
905 /*-------------------------------------------------------------------
906  * Attribute Server Utility APIs
907  */
908 
909 /*
910  * Parse Exchange MTU Request.
911  */
912 extern bStatus_t ATT_ParseExchangeMTUReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
913 
914 /*
915  * Parse Find Information Request.
916  */
917 extern bStatus_t ATT_ParseFindInfoReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
918 
919 /*
920  * Parse Find By Type Value Request.
921  */
922 extern bStatus_t ATT_ParseFindByTypeValueReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
923 
924 /*
925  * Parse Read By Type Request.
926  */
927 extern bStatus_t ATT_ParseReadByTypeReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
928 
929 /*
930  * Parse Read Request.
931  */
932 extern bStatus_t ATT_ParseReadReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
933 
934 /*
935  * Parse Write Blob Request.
936  */
937 extern bStatus_t ATT_ParseReadBlobReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
938 
939 /*
940  * Parse Read Multiple Request.
941  */
942 extern bStatus_t ATT_ParseReadMultiReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
943 
944 /*
945  * Parse Write Request.
946  */
947 extern bStatus_t ATT_ParseWriteReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
948 
949 /*
950  * Parse Execute Write Request.
951  */
952 extern bStatus_t ATT_ParseExecuteWriteReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
953 
954 /*
955  * Parse Prepare Write Request.
956  */
957 extern bStatus_t ATT_ParsePrepareWriteReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );
958 
959 /*
960  * Parse Handle Value Confirmation.
961  */
962 extern bStatus_t ATT_ParseHandleValueCfm( uint8 *pParams, uint16 len, attMsg_t *pMsg );
963 
965 
966 /*-------------------------------------------------------------------
967  * Attribute Client Public APIs
968  */
969 
988 extern bStatus_t ATT_ExchangeMTUReq( uint16 connHandle, attExchangeMTUReq_t *pReq );
989 
1002 extern bStatus_t ATT_FindInfoReq( uint16 connHandle, attFindInfoReq_t *pReq );
1003 
1016 extern bStatus_t ATT_FindByTypeValueReq( uint16 connHandle, attFindByTypeValueReq_t *pReq );
1017 
1030 extern bStatus_t ATT_ReadByTypeReq( uint16 connHandle, attReadByTypeReq_t *pReq );
1031 
1044 extern bStatus_t ATT_ReadReq( uint16 connHandle, attReadReq_t *pReq );
1045 
1058 extern bStatus_t ATT_ReadBlobReq( uint16 connHandle, attReadBlobReq_t *pReq );
1059 
1072 extern bStatus_t ATT_ReadMultiReq( uint16 connHandle, attReadMultiReq_t *pReq );
1073 
1086 extern bStatus_t ATT_ReadByGrpTypeReq( uint16 connHandle, attReadByGrpTypeReq_t *pReq );
1087 
1101 extern bStatus_t ATT_WriteReq( uint16 connHandle, attWriteReq_t *pReq );
1102 
1115 extern bStatus_t ATT_PrepareWriteReq( uint16 connHandle, attPrepareWriteReq_t *pReq );
1116 
1129 extern bStatus_t ATT_ExecuteWriteReq( uint16 connHandle, attExecuteWriteReq_t *pReq );
1130 
1142 extern bStatus_t ATT_HandleValueCfm( uint16 connHandle );
1143 
1144 
1145 /*-------------------------------------------------------------------
1146  * Attribute Server Public APIs
1147  */
1148 
1161 extern bStatus_t ATT_ErrorRsp( uint16 connHandle, attErrorRsp_t *pRsp );
1162 
1175 extern bStatus_t ATT_ExchangeMTURsp( uint16 connHandle, attExchangeMTURsp_t *pRsp );
1176 
1189 extern bStatus_t ATT_FindInfoRsp( uint16 connHandle, attFindInfoRsp_t *pRsp );
1190 
1203 extern bStatus_t ATT_FindByTypeValueRsp( uint16 connHandle, attFindByTypeValueRsp_t *pRsp );
1204 
1217 extern bStatus_t ATT_ReadByTypeRsp( uint16 connHandle, attReadByTypeRsp_t *pRsp );
1218 
1231 extern bStatus_t ATT_ReadRsp( uint16 connHandle, attReadRsp_t *pRsp );
1232 
1245 extern bStatus_t ATT_ReadBlobRsp( uint16 connHandle, attReadBlobRsp_t *pRsp );
1246 
1259 extern bStatus_t ATT_ReadMultiRsp( uint16 connHandle, attReadMultiRsp_t *pRsp ) ;
1260 
1273 extern bStatus_t ATT_ReadByGrpTypeRsp( uint16 connHandle, attReadByGrpTypeRsp_t *pRsp );
1274 
1286 extern bStatus_t ATT_WriteRsp( uint16 connHandle );
1287 
1300 extern bStatus_t ATT_PrepareWriteRsp( uint16 connHandle, attPrepareWriteRsp_t *pRsp );
1301 
1313 extern bStatus_t ATT_ExecuteWriteRsp( uint16 connHandle );
1314 
1327 extern bStatus_t ATT_HandleValueNoti( uint16 connHandle, attHandleValueNoti_t *pNoti );
1328 
1341 extern bStatus_t ATT_HandleValueInd( uint16 connHandle, attHandleValueInd_t *pInd );
1342 
1343 /*-------------------------------------------------------------------
1344  * Attribute Common Public APIs
1345  */
1346 
1356 extern uint8 ATT_UpdateMTU( uint16 connHandle, uint16 MTU );
1357 
1365 extern uint16 ATT_GetMTU( uint16 connHandle );
1366 
1373 extern void ATT_SetParamValue( uint16 value );
1374 
1380 extern uint16 ATT_GetParamValue( void );
1381 
1387 extern void ATT_RegisterServer( attNotifyTxCB_t pfnNotifyTx );
1388 
1394 extern void ATT_RegisterClient( attNotifyTxCB_t pfnNotifyTx );
1395 
1398 /*********************************************************************
1399 *********************************************************************/
1400 
1401 #ifdef __cplusplus
1402 }
1403 #endif
1404 
1405 #endif /* ATT_H */
1406 
uint16 endHandle
Last requested handle number.
Definition: att.h:357
void ATT_RegisterServer(attNotifyTxCB_t pfnNotifyTx)
Register the server's notify Tx function with the ATT layer.
bStatus_t ATT_ReadRsp(uint16 connHandle, attReadRsp_t *pRsp)
Send Read Response.
uint16 handle
Handle of the attribute to be read (must be first field)
Definition: att.h:450
uint16 len
Length of each attribute handle, end group handle and value set.
Definition: att.h:528
This API allows the software components in the Z-Stack to be written independently of the specifics o...
attFindInfoRsp_t findInfoRsp
ATT Find Information Response.
Definition: att.h:672
uint16 numInfo
Number of attribute handle-UUID pairs found.
Definition: att.h:381
attPrepareWriteRsp_t prepareWriteRsp
ATT Prepare Write Response.
Definition: att.h:679
L2CAP layer interface.
Exchange MTU Response format.
Definition: att.h:344
bStatus_t ATT_FindByTypeValueRsp(uint16 connHandle, attFindByTypeValueRsp_t *pRsp)
Send Find By Type Value Response.
Read Request.
Definition: att.h:448
uint16 numGrps
Number of attribute handle, end group handle and value sets found.
Definition: att.h:527
Find Information Response format.
Definition: att.h:379
bStatus_t ATT_ExecuteWriteReq(uint16 connHandle, attExecuteWriteReq_t *pReq)
Send Execute Write Request.
bStatus_t ATT_FindInfoReq(uint16 connHandle, attFindInfoReq_t *pReq)
Send Find Information Request.
uint8 * pHandlesInfo
List of 1 or more handles information (4 to ATT_MTU_SIZE-1)
Definition: att.h:415
bStatus_t ATT_ExchangeMTUReq(uint16 connHandle, attExchangeMTUReq_t *pReq)
Send Exchange MTU Request.
uint16 MTU
new MTU size
Definition: att.h:642
attReadByGrpTypeReq_t readByGrpTypeReq
ATT Read By Group Type Request.
Definition: att.h:664
uint16 numHandles
Number of attribute handles.
Definition: att.h:494
attPrepareWriteReq_t prepareWriteReq
ATT Prepare Write Request.
Definition: att.h:666
attAttrBtType_t type
2-octet UUID to find
Definition: att.h:395
uint8 reqOpcode
Request that generated this error response.
Definition: att.h:324
bStatus_t ATT_FindInfoRsp(uint16 connHandle, attFindInfoRsp_t *pRsp)
Send Find Information Response.
attMtuUpdatedEvt_t mtuEvt
ATT MTU Updated Event.
Definition: att.h:687
Find Information Request format.
Definition: att.h:354
Read Response.
Definition: att.h:458
Handle and its 128-bit UUID.
Definition: att.h:368
attErrorRsp_t errorRsp
ATT Error Response.
Definition: att.h:670
bStatus_t ATT_ExchangeMTURsp(uint16 connHandle, attExchangeMTURsp_t *pRsp)
Send Exchange MTU Response.
attHandleValueNoti_t handleValueNoti
ATT Handle Value Notification.
Definition: att.h:682
Error Response format.
Definition: att.h:322
attAttrType_t type
Requested group type (2 or 16 octet UUID)
Definition: att.h:517
Find By Type Value Request format.
Definition: att.h:391
uint8 sig
Authentication Signature status (not included (0), valid (1), invalid (2))
Definition: att.h:291
uint8 * pHandles
Set of two or more attribute handles (4 to ATT_MTU_SIZE-1) - must be first field. ...
Definition: att.h:493
#define ATT_BT_UUID_SIZE
Size of 16-bit Bluetooth UUID.
Definition: att.h:114
uint16 offset
Offset of the first octet to be written.
Definition: att.h:554
#define ATT_UUID_SIZE
Size of 128-bit UUID.
Definition: att.h:115
Write Request format.
Definition: att.h:537
uint8 flags
Definition: att.h:579
void ATT_RegisterClient(attNotifyTxCB_t pfnNotifyTx)
Register the client's notify Tx function with the ATT layer.
uint8 cmd
Command Flag.
Definition: att.h:543
uint16 len
Length of value.
Definition: att.h:482
bStatus_t ATT_ReadByTypeReq(uint16 connHandle, attReadByTypeReq_t *pReq)
Send Read By Type Request.
bStatus_t ATT_ReadByGrpTypeRsp(uint16 connHandle, attReadByGrpTypeRsp_t *pRsp)
Send Read By Group Type Respond.
uint16 len
Length of value.
Definition: att.h:568
uint8 * pDataList
List of 1 or more attribute handle-value pairs (2 to ATT_MTU_SIZE-2)
Definition: att.h:439
attReadMultiReq_t readMultiReq
ATT Read Multiple Request.
Definition: att.h:663
uint8 * pValue
Part of the value of the attribute to be written (0 to ATT_MTU_SIZE-5) - must be allocated.
Definition: att.h:556
uint16 len
Length of value.
Definition: att.h:460
uint16 startHandle
First requested handle number (must be first field)
Definition: att.h:393
uint16 handle
Handle of the attribute that has been read.
Definition: att.h:566
uint8 opcode
opcode of message that caused flow control violation
Definition: att.h:626
attFindInfoReq_t findInfoReq
ATT Find Information Request.
Definition: att.h:658
uint16 numPairs
Number of attribute handle-UUID pairs found.
Definition: att.h:437
attReadRsp_t readRsp
ATT Read Response.
Definition: att.h:675
bStatus_t ATT_PrepareWriteReq(uint16 connHandle, attPrepareWriteReq_t *pReq)
Send Prepare Write Request.
attHandleValueInd_t handleValueInd
ATT Handle Value Indication.
Definition: att.h:683
uint16 clientRxMTU
Client receive MTU size.
Definition: att.h:336
uint8 format
Format of information data.
Definition: att.h:382
uint16 offset
Offset of the first octet to be read.
Definition: att.h:472
uint16 startHandle
First requested handle number (must be first field)
Definition: att.h:356
uint16 len
Length of Attribute Parameters.
Definition: att.h:294
uint8 sig
Authentication Signature status (not included (0), valid (1), invalid (2))
Definition: att.h:542
Read By Group Type Response format.
Definition: att.h:525
attReadByTypeRsp_t readByTypeRsp
ATT Read By Type Response.
Definition: att.h:674
uint16 ATT_GetParamValue(void)
Get a ATT Parameter value.
ATT MTU Updated Event message format.
Definition: att.h:640
bStatus_t ATT_FindByTypeValueReq(uint16 connHandle, attFindByTypeValueReq_t *pReq)
Send Find By Type Value Request.
uint16 len
Length of values.
Definition: att.h:504
attExchangeMTUReq_t exchangeMTUReq
ATT Exchange MTU Request.
Definition: att.h:657
uint16 endHandle
Last requested handle number.
Definition: att.h:394
bStatus_t ATT_ReadByGrpTypeReq(uint16 connHandle, attReadByGrpTypeReq_t *pReq)
Send Read By Group Type Request.
Attribute Type format (2 or 16 octet UUID).
Definition: att.h:299
Read Multiple Response format.
Definition: att.h:502
bStatus_t ATT_HandleValueInd(uint16 connHandle, attHandleValueInd_t *pInd)
Send Handle Value Indication.
Read Blob Response format.
Definition: att.h:480
bStatus_t ATT_ReadByTypeRsp(uint16 connHandle, attReadByTypeRsp_t *pRsp)
Send Read By Type Respond.
attReadBlobReq_t readBlobReq
ATT Read Blob Request.
Definition: att.h:662
bStatus_t ATT_WriteRsp(uint16 connHandle)
Send Write Response.
uint16 endHandle
Last requested handle number.
Definition: att.h:426
Attribute Type format (2-octet Bluetooth UUID).
Definition: att.h:306
uint16 serverRxMTU
Server receive MTU size.
Definition: att.h:346
uint8 method
Method.
Definition: att.h:293
uint8 * pParams
Attribute Parameters.
Definition: att.h:295
uint16 offset
Offset of the first octet to be written.
Definition: att.h:567
uint8 * pValue
Value of the attribute to be written (0 to ATT_MTU_SIZE-3)
Definition: att.h:541
uint16 len
Length of value.
Definition: att.h:591
Read Blob Request format.
Definition: att.h:469
uint8 cmd
Command Flag.
Definition: att.h:292
uint8 * pValue
Part of the value of the attribute to be written (0 to ATT_MTU_SIZE-5)
Definition: att.h:569
Find By Type Value Response format.
Definition: att.h:412
bStatus_t ATT_PrepareWriteRsp(uint16 connHandle, attPrepareWriteRsp_t *pRsp)
Send Prepare Write Response.
ATT Flow Control Violated Event message format.
Definition: att.h:624
Read By Type Request format.
Definition: att.h:423
uint8 * pValue
Attribute value to find (0 to ATT_MTU_SIZE-7)
Definition: att.h:397
Read Multiple Request format.
Definition: att.h:491
uint8 * pValue
Current value of the attribute (0 to ATT_MTU_SIZE-3)
Definition: att.h:604
uint8 len
Length of UUID (2 or 16)
Definition: att.h:301
uint16 len
Length of value.
Definition: att.h:555
uint16 handle
Attribute handle that generated error response.
Definition: att.h:325
uint8 * pInfo
Information data whose format is determined by format field (4 to ATT_MTU_SIZE-2) ...
Definition: att.h:383
Handle Value Indication format.
Definition: att.h:600
uint16 handle
Handle of the attribute to be read (must be first field)
Definition: att.h:471
attExecuteWriteReq_t executeWriteReq
ATT Execute Write Request.
Definition: att.h:667
Type definitions and macros for BLE stack.
Handle Value Notification format.
Definition: att.h:588
uint16 startHandle
First requested handle number (must be first field)
Definition: att.h:425
uint16 handle
Handle of the attribute to be written (must be first field)
Definition: att.h:553
uint16 endHandle
Last requested handle number.
Definition: att.h:516
bStatus_t ATT_ReadBlobReq(uint16 connHandle, attReadBlobReq_t *pReq)
Send Read Blob Request.
ATT Message format.
Definition: att.h:654
attReadBlobRsp_t readBlobRsp
ATT Read Blob Response.
Definition: att.h:676
bStatus_t ATT_ReadMultiReq(uint16 connHandle, attReadMultiReq_t *pReq)
Send Read Multiple Request.
uint8 * pDataList
List of 1 or more attribute handle, end group handle and value (4 to ATT_MTU_SIZE-2) ...
Definition: att.h:529
uint16 handle
Handle of the attribute to be written (must be first field)
Definition: att.h:539
void ATT_SetParamValue(uint16 value)
Set a ATT Parameter value. Use this function to change the default ATT parameter values.
uint16 len
Length of value.
Definition: att.h:603
bStatus_t ATT_ExecuteWriteRsp(uint16 connHandle)
Send Execute Write Response.
attFlowCtrlViolatedEvt_t flowCtrlEvt
ATT Flow Control Violated Event.
Definition: att.h:686
uint16 handle
Handle of the attribute that has been changed (must be first field)
Definition: att.h:602
bStatus_t ATT_ReadReq(uint16 connHandle, attReadReq_t *pReq)
Send Read Request.
Exchange MTU Request format.
Definition: att.h:334
uint16 grpEndHandle
Group end handle.
Definition: att.h:404
uint16 len
Size of each attribute handle-value pair.
Definition: att.h:438
Attribute Protocol PDU format.
Definition: att.h:289
uint8 * pValue
Value of the attribute with the handle given (0 to ATT_MTU_SIZE-1)
Definition: att.h:461
uint8 * pValue
Part of the value of the attribute with the handle given (0 to ATT_MTU_SIZE-1)
Definition: att.h:483
uint16 dataLen
Length of data written into pDataList. Not part of actual ATT Response.
Definition: att.h:440
attAttrType_t type
Requested type (2 or 16 octet UUID)
Definition: att.h:427
uint8 ATT_UpdateMTU(uint16 connHandle, uint16 MTU)
This function is used to update the MTU size of a connection.
Read By Group Type Request format.
Definition: att.h:513
uint16 handle
Handle.
Definition: att.h:363
attReadByTypeReq_t readByTypeReq
ATT Read By Type Request.
Definition: att.h:660
Handle and its 16-bit Bluetooth UUIDs.
Definition: att.h:361
uint16 len
Length of value.
Definition: att.h:540
attReadByGrpTypeRsp_t readByGrpTypeRsp
ATT Read By Group Type Response.
Definition: att.h:678
bStatus_t ATT_ReadBlobRsp(uint16 connHandle, attReadBlobRsp_t *pRsp)
Send Read Blob Response.
Status_t bStatus_t
BLE Generic Status return.
Definition: bcomdef.h:242
uint8 pendingOpcode
opcode of pending message
Definition: att.h:627
uint8 len
Length of UUID (2)
Definition: att.h:308
Read By Type Response format.
Definition: att.h:435
Prepare Write Response format.
Definition: att.h:564
uint16 handle
Handle.
Definition: att.h:370
uint16 numInfo
Number of handles information found.
Definition: att.h:414
Prepare Write Request format.
Definition: att.h:551
attExchangeMTURsp_t exchangeMTURsp
ATT Exchange MTU Response.
Definition: att.h:671
bStatus_t ATT_ReadMultiRsp(uint16 connHandle, attReadMultiRsp_t *pRsp)
Send Read Multiple Response.
attFindByTypeValueReq_t findByTypeValueReq
ATT Find By Type Value Request.
Definition: att.h:659
bStatus_t ATT_WriteReq(uint16 connHandle, attWriteReq_t *pReq)
Send Write Request.
attReadReq_t readReq
ATT Read Request.
Definition: att.h:661
bStatus_t ATT_HandleValueNoti(uint16 connHandle, attHandleValueNoti_t *pNoti)
Send Handle Value Notification.
attReadMultiRsp_t readMultiRsp
ATT Read Multiple Response.
Definition: att.h:677
attWriteReq_t writeReq
ATT Write Request.
Definition: att.h:665
uint8 * pValues
Set of two or more values (0 to ATT_MTU_SIZE-1)
Definition: att.h:505
uint16 len
Length of value.
Definition: att.h:396
attFindByTypeValueRsp_t findByTypeValueRsp
ATT Find By Type Value Response.
Definition: att.h:673
uint8 * pValue
Current value of the attribute (0 to ATT_MTU_SIZE-3)
Definition: att.h:592
uint16 ATT_GetMTU(uint16 connHandle)
This function is used to get the MTU size of a connection.
uint16 handle
Found attribute handle.
Definition: att.h:403
uint16 startHandle
First requested handle number (must be first field)
Definition: att.h:515
uint8 errCode
Reason why the request has generated error response.
Definition: att.h:326
OSAL L2CAP_DATA_EVENT message format.
Definition: l2cap.h:574
bStatus_t ATT_HandleValueCfm(uint16 connHandle)
Send Handle Value Confirmation.
Execute Write Request format.
Definition: att.h:577
uint16 handle
Handle of the attribute that has been changed (must be first field)
Definition: att.h:590
bStatus_t ATT_ErrorRsp(uint16 connHandle, attErrorRsp_t *pRsp)
Send Error Response.
Handles Information format.
Definition: att.h:401
Copyright 2018, Texas Instruments Incorporated