Document inline SDP data read/write functions.

1 files changed, 58 insertions, 25 deletions

diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h b/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h
index a3913f6de..c9ce9511d 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h
@@ -104,49 +104,45 @@
 		} SDP_PDUHeader_t;
 		
 	/* Inline Functions: */
-		/** Adds a new Data Element container of the given type with a 16-bit size header to the buffer. The
-		 *  buffer pointer's position is advanced past the added header once the element has been added. The
-		 *  returned size header value is pre-zeroed out so that it can be incremented as data is placed into
-		 *  the Data Element container.
-		 *
-		 *  The total added size of the container header is three bytes, regardless of the size of its contents
-		 *  as long as the contents' size in bytes fits into a 16-bit integer.
+		/** Writes 8 bits of raw data to the given buffer, incrementing the buffer position afterwards.
 		 *
-		 *  \param[in, out] BufferPos  Pointer to a buffer where the container header is to be placed
-		 *  \param[in]      Type       Type of data the container is to store, a value from the \ref ServiceDiscovery_DataTypes_t enum
-		 *
-		 *  \return Pointer to the 16-bit size value of the contaner header, which has been pre-zeroed
+		 *  \param[in, out] BufferPos  Current position in the buffer where the data is to be written to
+		 *  \param[in]      Data       Data to write to the buffer
 		 */
-		static inline uint16_t* SDP_AddDataElementHeader16(void** BufferPos, const uint8_t Type)
-		{
-			*((uint8_t*)*BufferPos) = (SDP_DATASIZE_Variable16Bit | Type);
-			*BufferPos += sizeof(uint8_t);
-
-			uint16_t* SizePos = (uint16_t*)*BufferPos;
-			*BufferPos += sizeof(uint16_t);
-
-			*SizePos = 0;
-			return SizePos;
-		}
-		
 		static inline void SDP_WriteData8(void** BufferPos, uint8_t Data)
 		{
 			*((uint8_t*)*BufferPos) = Data;
 			*BufferPos += sizeof(uint8_t);
 		}
 		
+		/** Writes 16 bits of raw data to the given buffer, incrementing the buffer position afterwards.
+		 *
+		 *  \param[in, out] BufferPos  Current position in the buffer where the data is to be written to
+		 *  \param[in]      Data       Data to write to the buffer
+		 */
 		static inline void SDP_WriteData16(void** BufferPos, uint16_t Data)
 		{
 			*((uint16_t*)*BufferPos) = SwapEndian_16(Data);
 			*BufferPos += sizeof(uint16_t);
 		}		
 
+		/** Writes 32 bits of raw data to the given buffer, incrementing the buffer position afterwards.
+		 *
+		 *  \param[in, out] BufferPos  Current position in the buffer where the data is to be written to
+		 *  \param[in]      Data       Data to write to the buffer
+		 */
 		static inline void SDP_WriteData32(void** BufferPos, uint32_t Data)
 		{
 			*((uint32_t*)*BufferPos) = SwapEndian_32(Data);
 			*BufferPos += sizeof(uint32_t);
 		}
 
+		/** Reads 8 bits of raw data frpm the given buffer, incrementing the buffer position afterwards.
+		 *
+		 *  \param[in, out] BufferPos  Current position in the buffer where the data is to be read from
+		 *
+		 *  \return Data read from the buffer
+		 */
 		static inline uint8_t SDP_ReadData8(const void** BufferPos)
 		{
 			uint8_t Data = *((uint8_t*)*BufferPos);
@@ -155,6 +151,12 @@
 			return Data;
 		}
 
+		/** Reads 16 bits of raw data frpm the given buffer, incrementing the buffer position afterwards.
+		 *
+		 *  \param[in, out] BufferPos  Current position in the buffer where the data is to be read from
+		 *
+		 *  \return Data read from the buffer
+		 */
 		static inline uint16_t SDP_ReadData16(const void** BufferPos)
 		{
 			uint16_t Data = SwapEndian_16(*((uint16_t*)*BufferPos));
@@ -163,6 +165,12 @@
 			return Data;
 		}
 
+		/** Reads 32 bits of raw data frpm the given buffer, incrementing the buffer position afterwards.
+		 *
+		 *  \param[in, out] BufferPos  Current position in the buffer where the data is to be read from
+		 *
+		 *  \return Data read from the buffer
+		 */
 		static inline uint32_t SDP_ReadData32(const void** BufferPos)
 		{
 			uint32_t Data = SwapEndian_32(*((uint32_t*)*BufferPos));
@@ -170,16 +178,41 @@
 			
 			return Data;
 		}
+
+		/** Adds a new Data Element container of the given type with a 16-bit size header to the buffer. The
+		 *  buffer pointer's position is advanced past the added header once the element has been added. The
+		 *  returned size header value is pre-zeroed out so that it can be incremented as data is placed into
+		 *  the Data Element container.
+		 *
+		 *  The total added size of the container header is three bytes, regardless of the size of its contents
+		 *  as long as the contents' size in bytes fits into a 16-bit integer.
+		 *
+		 *  \param[in, out] BufferPos  Pointer to a buffer where the container header is to be placed
+		 *  \param[in]      Type       Type of data the container is to store, a value from the \ref ServiceDiscovery_DataTypes_t enum
+		 *
+		 *  \return Pointer to the 16-bit size value of the contaner header, which has been pre-zeroed
+		 */
+		static inline uint16_t* SDP_AddDataElementHeader16(void** BufferPos, const uint8_t Type)
+		{
+			SDP_WriteData8(BufferPos, (SDP_DATASIZE_Variable16Bit | Type));
+
+			uint16_t* SizePos = (uint16_t*)*BufferPos;
+			
+			SDP_WriteData16(BufferPos, 0);
+
+			return SizePos;
+		}
 		
 	/* Function Prototypes: */
-		void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* Channel);
+		void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel);
 
 		#if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)
 			static void SDP_ProcessServiceSearch(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 			static void SDP_ProcessServiceAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 			static void SDP_ProcessServiceSearchAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 
-			static uint16_t SDP_AddListedAttributesToResponse(const ServiceAttributeTable_t* AttributeTable, uint16_t AttributeList[][2], uint8_t TotalAttributes, void** BufferPos);
+			static uint16_t SDP_AddListedAttributesToResponse(const ServiceAttributeTable_t* AttributeTable, uint16_t AttributeList[][2],
+			                                                  const uint8_t TotalAttributes, void** const BufferPos);
 			static uint16_t SDP_AddAttributeToResponse(const uint16_t AttributeID, const void* AttributeValue, void** ResponseBuffer);
 			static void*    SDP_GetAttributeValue(const ServiceAttributeTable_t* AttributeTable, const uint16_t AttributeID);
 			static ServiceAttributeTable_t* SDP_GetAttributeTable(const uint8_t* const UUID);