X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/1daa5e16f9a395fb2943906a715adb35b8106988..16f09ab50a6a931f0d8ec22a191288641e937eb1:/LUFA/Drivers/USB/Core/EndpointStream.h

diff --git a/LUFA/Drivers/USB/Core/EndpointStream.h b/LUFA/Drivers/USB/Core/EndpointStream.h
index 4d4f33a20..b4454a330 100644
--- a/LUFA/Drivers/USB/Core/EndpointStream.h
+++ b/LUFA/Drivers/USB/Core/EndpointStream.h
@@ -29,10 +29,8 @@
 */
 
 /** \file
- *  \brief USB device endpoint stream function definitions.
- *
- *  This file contains structures, function prototypes and macros related to the sending and receiving of
- *  arbitrary data streams through the device's data endpoints when the library is initialized in USB device mode.
+ *  \brief Endpoint data stream transmission and reception management.
+ *  \copydetails Group_EndpointStreamRW
  *
  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  *        dispatch header located in LUFA/Drivers/USB/USB.h.
@@ -40,6 +38,7 @@
 
 /** \ingroup Group_EndpointRW  
  *  \defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams
+ *  \brief Endpoint data stream transmission and reception management.
  *
  *  Functions, macros, variables, enums and types related to data reading and writing of data streams from
  *  and to endpoints.
@@ -52,6 +51,7 @@
 
 	/* Includes: */
 		#include "../../../Common/Common.h"
+		#include "USBMode.h"		
 		#include "USBTask.h"
 		
 	/* Enable C linkage for C++ Compilers: */
@@ -467,8 +467,11 @@
 			/** \name Stream functions for EEPROM source/destination data */
 			//@{
 
+			#if defined(ARCH_HAS_EEPROM_ADDRESS_SPACE) || defined(__DOXYGEN__)
 			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE().
 			 *
+			 *  \note This function is not available on all architectures.
+			 *
 			 *  \param[in] Buffer          Pointer to the source data buffer to read from.
 			 *  \param[in] Length          Number of bytes to read for the currently selected endpoint into the buffer.
 			 *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes processed in the current
@@ -482,6 +485,8 @@
 
 			/** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE().
 			 *
+			 *  \note This function is not available on all architectures.
+			 *
 			 *  \param[in] Buffer          Pointer to the source data buffer to read from.
 			 *  \param[in] Length          Number of bytes to read for the currently selected endpoint into the buffer.
 			 *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes processed in the current
@@ -495,6 +500,8 @@
 
 			/** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().
 			 *
+			 *  \note This function is not available on all architectures.
+			 *
 			 *  \param[out] Buffer          Pointer to the destination data buffer to write to, located in EEPROM memory space.
 			 *  \param[in]  Length          Number of bytes to send via the currently selected endpoint.
 			 *  \param[in]  BytesProcessed  Pointer to a location where the total number of bytes processed in the current
@@ -508,6 +515,8 @@
 
 			/** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().
 			 *
+			 *  \note This function is not available on all architectures.
+			 *
 			 *  \param[out] Buffer          Pointer to the destination data buffer to write to, located in EEPROM memory space.
 			 *  \param[in]  Length          Number of bytes to send via the currently selected endpoint.
 			 *  \param[in]  BytesProcessed  Pointer to a location where the total number of bytes processed in the current
@@ -526,6 +535,9 @@
 			 *        \n\n
 			 *
 			 *  \note This routine should only be used on CONTROL type endpoints.
+			 *        \n\n
+			 *
+			 *  \note This function is not available on all architectures.
 			 *
 			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 			 *           together; i.e. the entire stream data must be read or written at the one time.
@@ -545,6 +557,9 @@
 			 *        \n\n
 			 *
 			 *  \note This routine should only be used on CONTROL type endpoints.
+			 *        \n\n
+			 *
+			 *  \note This function is not available on all architectures.
 			 *
 			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 			 *           together; i.e. the entire stream data must be read or written at the one time.
@@ -564,6 +579,9 @@
 			 *        \n\n
 			 *
 			 *  \note This routine should only be used on CONTROL type endpoints.
+			 *        \n\n
+			 *
+			 *  \note This function is not available on all architectures.
 			 *
 			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 			 *           together; i.e. the entire stream data must be read or written at the one time.
@@ -583,6 +601,9 @@
 			 *        \n\n
 			 *
 			 *  \note This routine should only be used on CONTROL type endpoints.
+			 *        \n\n
+			 *
+			 *  \note This function is not available on all architectures.
 			 *
 			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 			 *           together; i.e. the entire stream data must be read or written at the one time.
@@ -594,15 +615,19 @@
 			 */
 			uint8_t Endpoint_Read_Control_EStream_BE(void* const Buffer,
 			                                         uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+			#endif
 			//@}
 
 			/** \name Stream functions for PROGMEM source/destination data */
 			//@{
 
+			#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE) || defined(__DOXYGEN__)
 			/** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().
 			 *
 			 *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
 			 *
+			 *  \note This function is not available on all architectures.
+			 *
 			 *  \param[in] Buffer          Pointer to the source data buffer to read from.
 			 *  \param[in] Length          Number of bytes to read for the currently selected endpoint into the buffer.
 			 *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes processed in the current
@@ -618,6 +643,8 @@
 			 *
 			 *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
 			 *
+			 *  \note This function is not available on all architectures.
+			 *
 			 *  \param[in] Buffer          Pointer to the source data buffer to read from.
 			 *  \param[in] Length          Number of bytes to read for the currently selected endpoint into the buffer.
 			 *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes processed in the current
@@ -638,6 +665,9 @@
 			 *        \n\n
 			 *
 			 *  \note This routine should only be used on CONTROL type endpoints.
+			 *        \n\n
+			 *
+			 *  \note This function is not available on all architectures.
 			 *
 			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 			 *           together; i.e. the entire stream data must be read or written at the one time.
@@ -659,6 +689,9 @@
 			 *        \n\n
 			 *
 			 *  \note This routine should only be used on CONTROL type endpoints.
+			 *        \n\n
+			 *
+			 *  \note This function is not available on all architectures.
 			 *
 			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
 			 *           together; i.e. the entire stream data must be read or written at the one time.
@@ -670,6 +703,7 @@
 			 */
 			uint8_t Endpoint_Write_Control_PStream_BE(const void* const Buffer,
 			                                          uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+			#endif
 			//@}
 
 	/* Disable C linkage for C++ Compilers: */