Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for SDPServices.c.
  34  */
  35
  36 #ifndef _SDPSERVICES_H_
  37 #define _SDPSERVICES_H_
  38
  39         /* Includes: */
  40                 #include "SDP.h"
  41
  42         /* Macros: */
  43                 /** Size of a full 128 bit UUID, in bytes. */
  44                 #define UUID_SIZE_BYTES                         16
  45
  46                 /** First 80 bits common to all standardized Bluetooth services. */
  47                 #define BASE_80BIT_UUID                         0x0000, 0x0010, 0x0080, {0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB}
  48
  49                 #define RFCOMM_UUID                             {SWAPENDIAN_32(0x00000003), BASE_80BIT_UUID}
  50                 #define L2CAP_UUID                              {SWAPENDIAN_32(0x00000100), BASE_80BIT_UUID}
  51                 #define SP_CLASS_UUID                           {SWAPENDIAN_32(0x00001101), BASE_80BIT_UUID}
  52                 #define PUBLICBROWSEGROUP_CLASS_UUID            {SWAPENDIAN_32(0x00001002), BASE_80BIT_UUID}
  53
  54                 #define SDP_ATTRIBUTE_ID_SERVICERECORDHANDLE    0x0000
  55                 #define SDP_ATTRIBUTE_ID_SERVICECLASSIDS        0x0001
  56                 #define SDP_ATTRIBUTE_ID_PROTOCOLDESCRIPTORLIST 0x0004
  57                 #define SDP_ATTRIBUTE_ID_BROWSEGROUPLIST        0x0005
  58                 #define SDP_ATTRIBUTE_ID_LANGUAGEBASEATTROFFSET 0x0006
  59                 #define SDP_ATTRIBUTE_ID_SERVICENAME            0x0100
  60                 #define SDP_ATTRIBUTE_ID_SERVICEDESCRIPTION     0x0101
  61
  62                 /** Terminator for a service attribute table of type \ref ServiceAttributeTable_t. */
  63                 #define SERVICE_ATTRIBUTE_TABLE_TERMINATOR      {.Data = NULL}
  64
  65         /* Type Defines: */
  66                 /** Type define for a UUID value structure. This struct can be used to hold full 128-bit UUIDs. */
  67                 typedef struct
  68                 {
  69                         uint32_t A; /**< Bits 0-31 of the UUID. */
  70                         uint16_t B; /**< Bits 32-47 of the UUID. */
  71                         uint16_t C; /**< Bits 48-63 of the UUID. */
  72                         uint16_t D; /**< Bits 64-79 of the UUID. */
  73                         uint8_t  E[6]; /**< Bits 80-127 of the UUID. */
  74                 } UUID_t;
  75
  76                 /** Structure for the association of attribute ID values to an attribute value in FLASH. A table of these
  77                  *  structures can then be built up for each supported UUID service within the device.
  78                  *
  79                  *  \attention This table must be terminated with a \ref SERVICE_ATTRIBUTE_TABLE_TERMINATOR element.
  80                  */
  81                 typedef struct
  82                 {
  83                         uint16_t    AttributeID; /**< Attribute ID of the table element which the UUID service supports */
  84                         const void* Data; /**< Pointer to the attribute data, located in PROGMEM memory space */
  85                 } ServiceAttributeTable_t;
  86
  87                 /** Structure for a list of Data Elements containing 8-bit integers, for service attributes requiring such lists. */
  88                 typedef struct
  89                 {
  90                         uint8_t Header; /**< Data Element header, should be (SDP_DATATYPE_UnsignedInt | SDP_DATASIZE_8Bit) */
  91                         uint8_t Value; /**< Value to store in the list Data Element */
  92                 } Item8Bit_t;
  93
  94                 /** Structure for a list of Data Elements containing 16-bit integers, for service attributes requiring such lists. */
  95                 typedef struct
  96                 {
  97                         uint8_t  Header; /**< Data Element header, should be (SDP_DATATYPE_UnsignedInt | SDP_DATASIZE_16Bit) */
  98                         uint16_t Value; /**< Value to store in the list Data Element */
  99                 } Item16Bit_t;
 100
 101                 /** Structure for a list of Data Elements containing 32-bit integers, for service attributes requiring such lists. */
 102                 typedef struct
 103                 {
 104                         uint8_t  Header; /**< Data Element header, should be (SDP_DATATYPE_UnsignedInt | SDP_DATASIZE_32Bit) */
 105                         uint32_t Value; /**< Value to store in the list Data Element */
 106                 } Item32Bit_t;
 107
 108                 /** Structure for a list of Data Elements containing UUIDs, for service attributes requiring UUID lists. */
 109                 typedef struct
 110                 {
 111                         uint8_t Header; /**< Data Element header, should be (SDP_DATATYPE_UUID | SDP_DATASIZE_128Bit) */
 112                         UUID_t  UUID; /**< UUID to store in the list Data Element */
 113                 } ItemUUID_t;
 114
 115                 /** Structure for a list of Data Elements Sequences containing UUID Data Elements, for service attributes requiring
 116                  *  protocol lists.
 117                  */
 118                 typedef struct
 119                 {
 120                         uint8_t        Header; /**< Data Element header, should be (SDP_DATATYPE_Sequence | SDP_DATASIZE_Variable8Bit) */
 121                         uint8_t        Size; /**< Size of the inner Data Element sequence */
 122
 123                         struct
 124                         {
 125                                 ItemUUID_t UUID; /**< UUID to store in the protocol list Data Element sequence */
 126                         } Protocol;
 127                 } ItemProtocol_t;
 128
 129                 /** Structure for a list of Data Elements Sequences containing UUID Data Elements and an 8-bit param value, for service
 130                  *  attributes requiring extended protocol lists containing an 8-bit value.
 131                  */
 132                 typedef struct
 133                 {
 134                         uint8_t        Header; /**< Data Element header, should be (SDP_DATATYPE_Sequence | SDP_DATASIZE_Variable8Bit) */
 135                         uint8_t        Size; /**< Size of the inner Data Element sequence */
 136
 137                         struct
 138                         {
 139                                 ItemUUID_t UUID; /**< UUID to store in the protocol list Data Element sequence */
 140                                 Item8Bit_t Param; /**< 8-Bit Parameter associated with the service */
 141                         } Protocol;
 142                 } ItemProtocol_8BitParam_t;
 143
 144                 /** Structure for a list of Data Elements Sequences containing UUID Data Elements and an 16-bit param value, for service
 145                  *  attributes requiring extended protocol lists containing an 16-bit value.
 146                  */
 147                 typedef struct
 148                 {
 149                         uint8_t        Header; /**< Data Element header, should be (SDP_DATATYPE_Sequence | SDP_DATASIZE_Variable8Bit) */
 150                         uint8_t        Size; /**< Size of the inner Data Element sequence */
 151
 152                         struct
 153                         {
 154                                 ItemUUID_t UUID; /**< UUID to store in the protocol list Data Element sequence */
 155                                 Item16Bit_t Channel; /**< 16-Bit Parameter associated with the service */
 156                         } Protocol;
 157                 } ItemProtocol_16BitParam_t;
 158
 159                 /** Structure for a list of Data Elements containing language encodings, including the language ID, Encoding ID and
 160                  *  Attribute base offset.
 161                  */
 162                 typedef struct
 163                 {
 164                         Item16Bit_t LanguageID; /**< Language ID for the current language */
 165                         Item16Bit_t EncodingID; /**< Encoding used for the current language */
 166                         Item16Bit_t OffsetID; /**< Attribute offset added to all strings using this language within the service */
 167                 } ItemLangEncoding_t;
 168
 169         /* External Variables: */
 170                 extern const ServiceAttributeTable_t SerialPort_Attribute_Table[];
 171                 extern const ServiceAttributeTable_t PnP_Attribute_Table[];
 172
 173 #endif
 174