More documentation fixes.

[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / Lib / SDPServices.h

diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h b/Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h
index 0fd0aa4..7e33638 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h
@@ -44,34 +44,58 @@
                #define UUID_SIZE_BYTES                         16\r
                \r
                /** First 80 bits common to all standardized Bluetooth services. */\r
                #define UUID_SIZE_BYTES                         16\r
                \r
                /** First 80 bits common to all standardized Bluetooth services. */\r

-               #define BASE_80BIT_UUID                         SWAPENDIAN_32(0xFB349B5F), SWAPENDIAN_16(0x8000), SWAPENDIAN_16(0x0080), SWAPENDIAN_16(0x0010)\r
+               #define BASE_80BIT_UUID                         0x0000, 0x0010, 0x0080, {0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB}\r
+               \r
+               #define RFCOMM_UUID                             {SWAPENDIAN_32(0x00000003), BASE_80BIT_UUID}\r
+               #define L2CAP_UUID                              {SWAPENDIAN_32(0x00000100), BASE_80BIT_UUID}\r
+               #define SP_CLASS_UUID                           {SWAPENDIAN_32(0x00001101), BASE_80BIT_UUID}\r
+               #define PUBLICBROWSEGROUP_CLASS_UUID            {SWAPENDIAN_32(0x00001002), BASE_80BIT_UUID}\r

                \r
                #define SDP_ATTRIBUTE_ID_SERVICERECORDHANDLE    0x0000\r
                #define SDP_ATTRIBUTE_ID_SERVICECLASSIDS        0x0001\r
                \r
                #define SDP_ATTRIBUTE_ID_SERVICERECORDHANDLE    0x0000\r
                #define SDP_ATTRIBUTE_ID_SERVICECLASSIDS        0x0001\r

-               #define SDP_ATTRIBUTE_ID_LANGIDOFFSET           0x0006\r
-               #define SDP_ATTRIBUTE_ID_VERSION                0x0200\r
+               #define SDP_ATTRIBUTE_ID_PROTOCOLDESCRIPTORLIST 0x0004\r
+               #define SDP_ATTRIBUTE_ID_BROWSEGROUPLIST        0x0005\r
+               #define SDP_ATTRIBUTE_ID_LANGUAGEBASEATTROFFSET 0x0006\r

                #define SDP_ATTRIBUTE_ID_SERVICENAME            0x0100\r
                #define SDP_ATTRIBUTE_ID_SERVICEDESCRIPTION     0x0101\r
                \r
                #define SDP_ATTRIBUTE_ID_SERVICENAME            0x0100\r
                #define SDP_ATTRIBUTE_ID_SERVICEDESCRIPTION     0x0101\r
                \r

+               /** Swaps the byte ordering of a 16-bit value at compile time. Do not use this macro for swapping byte orderings\r
+                *  of dynamic values computed at runtime -- use SwapEndian_16() instead.\r
+                *\r
+                *  \param[in]  x  16-bit value whose byte ordering is to be swapped\r
+                *\r
+                *  \return Input value with the byte ordering reversed\r
+                */\r

                #define SWAPENDIAN_16(x)                        ((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8))\r
                #define SWAPENDIAN_16(x)                        ((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8))\r

-               #define SWAPENDIAN_32(x)                        ((((x) & 0xFF000000) >> 24) | (((x) & 0x00FF0000) >> 8) | \\r
-                                                                (((x) & 0x0000FF00) << 8) | (((x) & 0x000000FF) << 24))\r
+\r
+               /** Swaps the byte ordering of a 32-bit value at compile time. Do not use this macro for swapping byte orderings\r
+                *  of dynamic values computed at runtime -- use SwapEndian_32() instead.\r
+                *\r
+                *  \param[in]  x  32-bit value whose byte ordering is to be swapped\r
+                *\r
+                *  \return Input value with the byte ordering reversed\r
+                */\r
+               #define SWAPENDIAN_32(x)                        ((((x) & 0xFF000000UL) >> 24UL) | (((x) & 0x00FF0000UL) >> 8UL) | \\r
+                                                                (((x) & 0x0000FF00UL) << 8UL) | (((x) & 0x000000FFUL) << 24UL))\r

                \r
                /** Terminator for a service attribute table of type \ref ServiceAttributeTable_t. */\r
                #define SERVICE_ATTRIBUTE_TABLE_TERMINATOR      {.Data = NULL}\r
                \r
        /* Type Defines: */\r
                \r
                /** Terminator for a service attribute table of type \ref ServiceAttributeTable_t. */\r
                #define SERVICE_ATTRIBUTE_TABLE_TERMINATOR      {.Data = NULL}\r
                \r
        /* Type Defines: */\r

+               /** Type define for a UUID value structure. This struct can be used to hold full 128-bit UUIDs. */\r

                typedef struct\r
                {\r
                typedef struct\r
                {\r

-                       uint32_t A;\r
-                       uint16_t B;\r
-                       uint16_t C;\r
-                       uint16_t D;\r
-                       uint8_t  E[6];\r
+                       uint32_t A; /**< Bits 0-31 of the UUID. */\r
+                       uint16_t B; /**< Bits 32-47 of the UUID. */\r
+                       uint16_t C; /**< Bits 48-63 of the UUID. */\r
+                       uint16_t D; /**< Bits 64-79 of the UUID. */\r
+                       uint8_t  E[6]; /**< Bits 80-128 of the UUID. */\r

                } UUID_t;\r
        \r
                /** Structure for the association of attribute ID values to an attribute value in FLASH. A table of these\r
                 *  structures can then be built up for each supported UUID service within the device.\r
                } UUID_t;\r
        \r
                /** Structure for the association of attribute ID values to an attribute value in FLASH. A table of these\r
                 *  structures can then be built up for each supported UUID service within the device.\r

+                *\r
+                *  \note This table must be terminated with a \ref SERVICE_ATTRIBUTE_TABLE_TERMINATOR element.\r

                 */\r
                typedef struct\r
                {\r
                 */\r
                typedef struct\r
                {\r


@@ -79,22 +103,6 @@
                        const void* Data; /**< Pointer to the attribute data, located in PROGMEM memory space */\r
                } ServiceAttributeTable_t;\r
 \r
                        const void* Data; /**< Pointer to the attribute data, located in PROGMEM memory space */\r
                } ServiceAttributeTable_t;\r
 \r

-               /** Structure for the association of service UUID values to attribute tables stored in FLASH. A table of these\r
-                *  structures can then be built up for each supported UUID service within the device.\r
-                */\r
-               typedef struct\r
-               {\r
-                       UUID_t      UUID; /**< UUID of a service supported by the device */\r
-                       const void* AttributeTable; /**< Pointer to the UUID's attribute table, located in PROGMEM memory space */\r
-               } ServiceTable_t;\r
-\r
-               /** Structure for a list of Data Elements containing UUIDs, for service attributes requiring UUID lists. */\r
-               typedef struct\r
-               {\r
-                       uint8_t Header; /**< Data Element header, should be (SDP_DATATYPE_UUID | SDP_DATASIZE_128Bit) */\r
-                       UUID_t  UUID; /**< UUID to store in the list Data Element */\r
-               } ItemUUID_t;\r
-\r

                /** Structure for a list of Data Elements containing 8-bit integers, for service attributes requiring such lists. */\r
                typedef struct\r
                {\r
                /** Structure for a list of Data Elements containing 8-bit integers, for service attributes requiring such lists. */\r
                typedef struct\r
                {\r


@@ -116,8 +124,54 @@
                        uint32_t Value; /**< Value to store in the list Data Element */\r
                } Item32Bit_t;\r
 \r
                        uint32_t Value; /**< Value to store in the list Data Element */\r
                } Item32Bit_t;\r
 \r

+               /** Structure for a list of Data Elements containing UUIDs, for service attributes requiring UUID lists. */\r
+               typedef struct\r
+               {\r
+                       uint8_t Header; /**< Data Element header, should be (SDP_DATATYPE_UUID | SDP_DATASIZE_128Bit) */\r
+                       UUID_t  UUID; /**< UUID to store in the list Data Element */\r
+               } ItemUUID_t;\r
+               \r
+               /** Structure for a list of Data Elements Sequences containing UUID Data Elements, for service attributes requiring\r
+                *  protocol lists.\r
+                */\r
+               typedef struct\r
+               {\r
+                       uint8_t        Header; /**< Data Element header, should be (SDP_DATATYPE_Sequence | SDP_DATASIZE_Variable8Bit) */\r
+                       uint8_t        Size; /**< Size of the inner Data Element sequence */\r
+                       \r
+                       struct\r
+                       {\r
+                               ItemUUID_t UUID; /**< UUID to store in the protocol list Data Element sequence */\r
+                       } Protocol;\r
+               } ItemProtocol_t;\r
+\r
+               /** Structure for a list of Data Elements Sequences containing UUID Data Elements and 8-bit channel values, for service\r
+                *  attributes requiring extended protocol lists.\r
+                */\r
+               typedef struct\r
+               {\r
+                       uint8_t        Header; /**< Data Element header, should be (SDP_DATATYPE_Sequence | SDP_DATASIZE_Variable8Bit) */\r
+                       uint8_t        Size; /**< Size of the inner Data Element sequence */\r
+                       \r
+                       struct\r
+                       {\r
+                               ItemUUID_t UUID; /**< UUID to store in the protocol list Data Element sequence */\r
+                               Item8Bit_t Channel; /**< Channel that is to be used to access the service */\r
+                       } Protocol;\r
+               } ItemProtocolChannel_t;\r
+               \r
+               /** Structure for a list of Data Elements containing language encodings, including the language ID, Encoding ID and\r
+                *  Attribute base offset.\r
+                */\r
+               typedef struct\r
+               {\r
+                       Item16Bit_t LanguageID; /**< Language ID for the current language */\r
+                       Item16Bit_t EncodingID; /**< Encoding used for the current language */\r
+                       Item16Bit_t OffsetID; /**< Attribute offset added to all strings using this language within the service */\r
+               } ItemLangEncoding_t;\r
+               \r

        /* External Variables: */\r
        /* External Variables: */\r

-               extern const ServiceAttributeTable_t SDP_Attribute_Table[];\r
-               extern const ServiceAttributeTable_t RFCOMM_Attribute_Table[];\r
+               extern const ServiceAttributeTable_t SerialPort_Attribute_Table[];\r
+               extern const ServiceAttributeTable_t PnP_Attribute_Table[];\r

                \r
 #endif\r
                \r
 #endif\r