Update architecture specific makefile templates so that they are as close to one...

[pub/USBasp.git] / LUFA / Drivers / USB / Core / PipeStream.h

diff --git a/LUFA/Drivers/USB/Core/PipeStream.h b/LUFA/Drivers/USB/Core/PipeStream.h
index c579631..c914fc1 100644 (file)
--- a/LUFA/Drivers/USB/Core/PipeStream.h
+++ b/LUFA/Drivers/USB/Core/PipeStream.h
@@ -363,8 +363,11 @@
                        /** \name Stream functions for EEPROM source/destination data */\r
                        //@{\r
                        \r
                        /** \name Stream functions for EEPROM source/destination data */\r
                        //@{\r
                        \r

+                       #if defined(ARCH_HAS_EEPROM_ADDRESS_SPACE) || defined(__DOXYGEN__)\r

                        /** EEPROM buffer source version of \ref Pipe_Write_Stream_LE().\r
                         *\r
                        /** EEPROM buffer source version of \ref Pipe_Write_Stream_LE().\r
                         *\r

+                        *  \note This function is not available on all architectures.\r
+                        *\r

                         *  \param[in] Buffer          Pointer to the source data buffer to read from.\r
                         *  \param[in] Length          Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should\r
                         *  \param[in] Buffer          Pointer to the source data buffer to read from.\r
                         *  \param[in] Length          Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should\r


@@ -378,6 +381,8 @@
                        \r
                        /** EEPROM buffer source version of \ref Pipe_Write_Stream_BE().\r
                         *\r
                        \r
                        /** EEPROM buffer source version of \ref Pipe_Write_Stream_BE().\r
                         *\r

+                        *  \note This function is not available on all architectures.\r
+                        *\r

                         *  \param[in] Buffer          Pointer to the source data buffer to read from.\r
                         *  \param[in] Length          Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should\r
                         *  \param[in] Buffer          Pointer to the source data buffer to read from.\r
                         *  \param[in] Length          Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should\r


@@ -391,6 +396,8 @@
 \r
                        /** EEPROM buffer source version of \ref Pipe_Read_Stream_LE().\r
                         *\r
 \r
                        /** EEPROM buffer source version of \ref Pipe_Read_Stream_LE().\r
                         *\r

+                        *  \note This function is not available on all architectures.\r
+                        *\r

                         *  \param[out] Buffer          Pointer to the source data buffer to write to.\r
                         *  \param[in]  Length          Number of bytes to read for the currently selected pipe to read from.\r
                         *  \param[in]  BytesProcessed  Pointer to a location where the total number of bytes already processed should\r
                         *  \param[out] Buffer          Pointer to the source data buffer to write to.\r
                         *  \param[in]  Length          Number of bytes to read for the currently selected pipe to read from.\r
                         *  \param[in]  BytesProcessed  Pointer to a location where the total number of bytes already processed should\r


@@ -404,6 +411,8 @@
                        \r
                        /** EEPROM buffer source version of \ref Pipe_Read_Stream_BE().\r
                         *\r
                        \r
                        /** EEPROM buffer source version of \ref Pipe_Read_Stream_BE().\r
                         *\r

+                        *  \note This function is not available on all architectures.\r
+                        *\r

                         *  \param[out] Buffer          Pointer to the source data buffer to write to.\r
                         *  \param[in]  Length          Number of bytes to read for the currently selected pipe to read from.\r
                         *  \param[in]  BytesProcessed  Pointer to a location where the total number of bytes already processed should\r
                         *  \param[out] Buffer          Pointer to the source data buffer to write to.\r
                         *  \param[in]  Length          Number of bytes to read for the currently selected pipe to read from.\r
                         *  \param[in]  BytesProcessed  Pointer to a location where the total number of bytes already processed should\r


@@ -414,15 +423,19 @@
                        uint8_t Pipe_Read_EStream_BE(void* const Buffer,\r
                                                     uint16_t Length,\r
                                                     uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
                        uint8_t Pipe_Read_EStream_BE(void* const Buffer,\r
                                                     uint16_t Length,\r
                                                     uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r

+                       #endif\r

                        //@}\r
 \r
                        /** \name Stream functions for PROGMEM source/destination data */\r
                        //@{\r
                        \r
                        //@}\r
 \r
                        /** \name Stream functions for PROGMEM source/destination data */\r
                        //@{\r
                        \r

+                       #if defined(ARCH_HAS_FLASH_ADDRESS_SPACE) || defined(__DOXYGEN__)\r

                        /** FLASH buffer source version of \ref Pipe_Write_Stream_LE().\r
                         *\r
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
                         *\r
                        /** FLASH buffer source version of \ref Pipe_Write_Stream_LE().\r
                         *\r
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
                         *\r

+                        *  \note This function is not available on all architectures.\r
+                        *\r

                         *  \param[in] Buffer          Pointer to the source data buffer to read from.\r
                         *  \param[in] Length          Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should\r
                         *  \param[in] Buffer          Pointer to the source data buffer to read from.\r
                         *  \param[in] Length          Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should\r


@@ -438,6 +451,8 @@
                         *\r
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
                         *\r
                         *\r
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
                         *\r

+                        *  \note This function is not available on all architectures.\r
+                        *\r

                         *  \param[in] Buffer          Pointer to the source data buffer to read from.\r
                         *  \param[in] Length          Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should\r
                         *  \param[in] Buffer          Pointer to the source data buffer to read from.\r
                         *  \param[in] Length          Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param[in] BytesProcessed  Pointer to a location where the total number of bytes already processed should\r


@@ -448,6 +463,7 @@
                        uint8_t Pipe_Write_PStream_BE(const void* const Buffer,\r
                                                      uint16_t Length,\r
                                                      uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
                        uint8_t Pipe_Write_PStream_BE(const void* const Buffer,\r
                                                      uint16_t Length,\r
                                                      uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r

+                       #endif\r

                        //@}\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                        //@}\r
 \r
        /* Disable C linkage for C++ Compilers: */\r