X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/5e7319058268e021ae39ca4b9fcabaec0060117b..16f09ab50a6a931f0d8ec22a191288641e937eb1:/LUFA/Drivers/USB/Core/EndpointStream.h diff --git a/LUFA/Drivers/USB/Core/EndpointStream.h b/LUFA/Drivers/USB/Core/EndpointStream.h index a8fd4bc93..b4454a330 100644 --- a/LUFA/Drivers/USB/Core/EndpointStream.h +++ b/LUFA/Drivers/USB/Core/EndpointStream.h @@ -51,6 +51,7 @@ /* Includes: */ #include "../../../Common/Common.h" + #include "USBMode.h" #include "USBTask.h" /* Enable C linkage for C++ Compilers: */ @@ -466,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 @@ -481,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 @@ -494,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 @@ -507,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 @@ -525,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. @@ -544,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. @@ -563,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. @@ -582,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. @@ -593,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 @@ -617,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 @@ -637,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. @@ -658,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. @@ -669,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: */