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

diff --git a/LUFA/Drivers/USB/Core/PipeStream.h b/LUFA/Drivers/USB/Core/PipeStream.h
index 86c544ebe..c914fc149 100644
--- a/LUFA/Drivers/USB/Core/PipeStream.h
+++ b/LUFA/Drivers/USB/Core/PipeStream.h
@@ -29,10 +29,8 @@
 */
  
 /** \file
- *  \brief USB host pipe 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 pipes when the library is initialized in USB host mode.
+ *  \brief Pipe data stream transmission and reception management.
+ *  \copydetails Group_PipeStreamRW
  *
  *  \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_PipeRW  
  *  \defgroup Group_PipeStreamRW Read/Write of Multi-Byte Streams
+ *  \brief Pipe data stream transmission and reception management.
  *
  *  Functions, macros, variables, enums and types related to data reading and writing of data streams from
  *  and to pipes.
@@ -52,6 +51,7 @@
 
 	/* Includes: */
 		#include "../../../Common/Common.h"
+		#include "USBMode.h"		
 		#include "USBTask.h"
 		
 	/* Enable C linkage for C++ Compilers: */
@@ -363,8 +363,11 @@
 			/** \name Stream functions for EEPROM source/destination data */
 			//@{
 			
+			#if defined(ARCH_HAS_EEPROM_ADDRESS_SPACE) || defined(__DOXYGEN__)
 			/** EEPROM buffer source version of \ref Pipe_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 pipe into the buffer.
 			 *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should
@@ -378,6 +381,8 @@
 			
 			/** EEPROM buffer source version of \ref Pipe_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 pipe into the buffer.
 			 *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should
@@ -391,6 +396,8 @@
 
 			/** EEPROM buffer source version of \ref Pipe_Read_Stream_LE().
 			 *
+			 *  \note This function is not available on all architectures.
+			 *
 			 *  \param[out] Buffer          Pointer to the source data buffer to write to.
 			 *  \param[in]  Length          Number of bytes to read for the currently selected pipe to read from.
 			 *  \param[in]  BytesProcessed  Pointer to a location where the total number of bytes already processed should
@@ -404,6 +411,8 @@
 			
 			/** EEPROM buffer source version of \ref Pipe_Read_Stream_BE().
 			 *
+			 *  \note This function is not available on all architectures.
+			 *
 			 *  \param[out] Buffer          Pointer to the source data buffer to write to.
 			 *  \param[in]  Length          Number of bytes to read for the currently selected pipe to read from.
 			 *  \param[in]  BytesProcessed  Pointer to a location where the total number of bytes already processed should
@@ -414,15 +423,19 @@
 			uint8_t Pipe_Read_EStream_BE(void* const Buffer,
 			                             uint16_t Length,
 			                             uint16_t* const BytesProcessed) 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 Pipe_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 pipe into the buffer.
 			 *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should
@@ -438,6 +451,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 pipe into the buffer.
 			 *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should
@@ -448,6 +463,7 @@
 			uint8_t Pipe_Write_PStream_BE(const void* const Buffer,
 			                              uint16_t Length,
 			                              uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);
+			#endif
 			//@}
 
 	/* Disable C linkage for C++ Compilers: */