typedef uint8_t uint_reg_t;
- #define ARCH_LITTLE_ENDIAN
+ #define ARCH_HAS_EEPROM_ADDRESS_SPACE
+ #define ARCH_HAS_FLASH_ADDRESS_SPACE
+ #define ARCH_HAS_MULTI_ADDRESS_SPACE
+ #define ARCH_LITTLE_ENDIAN
+
#include "Endianness.h"
#elif (ARCH == ARCH_UC3)
#include <avr32/io.h>
#define _delay_ms(x)
#define memcmp_P(...) memcmp(__VA_ARGS__)
#define memcpy_P(...) memcpy(__VA_ARGS__)
- #define USE_RAM_DESCRIPTORS
// ==================================================
typedef uint32_t uint_reg_t;
#define ARCH_BIG_ENDIAN
+
#include "Endianness.h"
#else
#error Unknown device architecture specified.
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,\r
const uint8_t wIndex,\r
const void** const DescriptorAddress\r
- #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)\r
+ #if (defined(ARCH_HAS_MULTI_ADDRESS_SPACE) || defined(__DOXYGEN__)) && \\r
+ !(defined(USE_FLASH_DESCRIPTORS) || defined(USE_EEPROM_DESCRIPTORS) || defined(USE_RAM_DESCRIPTORS))\r
, uint8_t* MemoryAddressSpace\r
#endif\r
) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);\r
if ((DescriptorSize = CALLBACK_USB_GetDescriptor(USB_ControlRequest.wValue, USB_ControlRequest.wIndex,
&DescriptorPointer
- #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
+ #if defined(ARCH_HAS_MULTI_ADDRESS_SPACE) && \
+ !(defined(USE_FLASH_DESCRIPTORS) || defined(USE_EEPROM_DESCRIPTORS) || defined(USE_RAM_DESCRIPTORS))
, &DescriptorAddressSpace
#endif
)) == NO_DESCRIPTOR)
Endpoint_ClearSETUP();
- #if defined(USE_RAM_DESCRIPTORS)
+ #if defined(USE_RAM_DESCRIPTORS) || !defined(ARCH_HAS_MULTI_ADDRESS_SPACE)
Endpoint_Write_Control_Stream_LE(DescriptorPointer, DescriptorSize);
#elif defined(USE_EEPROM_DESCRIPTORS)
Endpoint_Write_Control_EStream_LE(DescriptorPointer, DescriptorSize);
#endif
/* Public Interface - May be used in end-application: */
- /* Macros: */
- #if defined(USE_SINGLE_DEVICE_CONFIGURATION)
- #define FIXED_NUM_CONFIGURATIONS 1
- #endif
-
/* Enums: */
- #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
+ #if defined(ARCH_HAS_MULTI_ADDRESS_SPACE) || defined(__DOXYGEN__)
/** Enum for the possible descriptor memory spaces, for the \c MemoryAddressSpace parameter of the
* \ref CALLBACK_USB_GetDescriptor() function. This can be used when none of the \c USE_*_DESCRIPTORS
* compile time options are used, to indicate in which memory space the descriptor is stored.
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(*BufferPtr)\r
#include "Template/Template_Endpoint_RW.c"\r
\r
-#define TEMPLATE_FUNC_NAME Endpoint_Write_PStream_LE\r
-#define TEMPLATE_BUFFER_TYPE const void*\r
-#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(pgm_read_byte(BufferPtr))\r
-#include "Template/Template_Endpoint_RW.c"\r
-\r
-#define TEMPLATE_FUNC_NAME Endpoint_Write_EStream_LE\r
-#define TEMPLATE_BUFFER_TYPE const void*\r
-#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(eeprom_read_byte(BufferPtr))\r
-#include "Template/Template_Endpoint_RW.c"\r
-\r
#define TEMPLATE_FUNC_NAME Endpoint_Write_Stream_BE\r
#define TEMPLATE_BUFFER_TYPE const void*\r
#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(*BufferPtr)\r
#include "Template/Template_Endpoint_RW.c"\r
\r
-#define TEMPLATE_FUNC_NAME Endpoint_Write_EStream_BE\r
-#define TEMPLATE_BUFFER_TYPE const void*\r
-#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(eeprom_read_byte(BufferPtr))\r
-#include "Template/Template_Endpoint_RW.c"\r
-\r
-#define TEMPLATE_FUNC_NAME Endpoint_Write_PStream_BE\r
-#define TEMPLATE_BUFFER_TYPE const void*\r
-#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(pgm_read_byte(BufferPtr))\r
-#include "Template/Template_Endpoint_RW.c"\r
-\r
#define TEMPLATE_FUNC_NAME Endpoint_Read_Stream_LE\r
#define TEMPLATE_BUFFER_TYPE void*\r
#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearOUT()\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) *BufferPtr = Endpoint_Read_Byte()\r
#include "Template/Template_Endpoint_RW.c"\r
\r
-#define TEMPLATE_FUNC_NAME Endpoint_Read_EStream_LE\r
-#define TEMPLATE_BUFFER_TYPE void*\r
-#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearOUT()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Endpoint_Read_Byte())\r
-#include "Template/Template_Endpoint_RW.c"\r
-\r
#define TEMPLATE_FUNC_NAME Endpoint_Read_Stream_BE\r
#define TEMPLATE_BUFFER_TYPE void*\r
#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearOUT()\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) *BufferPtr = Endpoint_Read_Byte()\r
#include "Template/Template_Endpoint_RW.c"\r
\r
-#define TEMPLATE_FUNC_NAME Endpoint_Read_EStream_BE\r
-#define TEMPLATE_BUFFER_TYPE void*\r
-#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearOUT()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Endpoint_Read_Byte())\r
-#include "Template/Template_Endpoint_RW.c"\r
+#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Write_PStream_LE\r
+ #define TEMPLATE_BUFFER_TYPE const void*\r
+ #define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) 0\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(pgm_read_byte(BufferPtr))\r
+ #include "Template/Template_Endpoint_RW.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Write_PStream_BE\r
+ #define TEMPLATE_BUFFER_TYPE const void*\r
+ #define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(pgm_read_byte(BufferPtr))\r
+ #include "Template/Template_Endpoint_RW.c"\r
+#endif\r
+\r
+#if defined(ARCH_HAS_EEPROM_ADDRESS_SPACE)\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Write_EStream_LE\r
+ #define TEMPLATE_BUFFER_TYPE const void*\r
+ #define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) 0\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(eeprom_read_byte(BufferPtr))\r
+ #include "Template/Template_Endpoint_RW.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Write_EStream_BE\r
+ #define TEMPLATE_BUFFER_TYPE const void*\r
+ #define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(eeprom_read_byte(BufferPtr))\r
+ #include "Template/Template_Endpoint_RW.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Read_EStream_LE\r
+ #define TEMPLATE_BUFFER_TYPE void*\r
+ #define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearOUT()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) 0\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Endpoint_Read_Byte())\r
+ #include "Template/Template_Endpoint_RW.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Read_EStream_BE\r
+ #define TEMPLATE_BUFFER_TYPE void*\r
+ #define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearOUT()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Endpoint_Read_Byte())\r
+ #include "Template/Template_Endpoint_RW.c"\r
+#endif\r
\r
#endif\r
\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(*BufferPtr)\r
#include "Template/Template_Endpoint_Control_W.c"\r
\r
-#define TEMPLATE_FUNC_NAME Endpoint_Write_Control_PStream_LE\r
-#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(pgm_read_byte(BufferPtr))\r
-#include "Template/Template_Endpoint_Control_W.c"\r
-\r
-#define TEMPLATE_FUNC_NAME Endpoint_Write_Control_EStream_LE\r
-#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(eeprom_read_byte(BufferPtr))\r
-#include "Template/Template_Endpoint_Control_W.c"\r
-\r
#define TEMPLATE_FUNC_NAME Endpoint_Write_Control_Stream_BE\r
#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(*BufferPtr)\r
#include "Template/Template_Endpoint_Control_W.c"\r
\r
-#define TEMPLATE_FUNC_NAME Endpoint_Write_Control_PStream_BE\r
-#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(pgm_read_byte(BufferPtr))\r
-#include "Template/Template_Endpoint_Control_W.c"\r
-\r
-#define TEMPLATE_FUNC_NAME Endpoint_Write_Control_EStream_BE\r
-#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(eeprom_read_byte(BufferPtr))\r
-#include "Template/Template_Endpoint_Control_W.c"\r
-\r
#define TEMPLATE_FUNC_NAME Endpoint_Read_Control_Stream_LE\r
#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) *BufferPtr = Endpoint_Read_Byte()\r
#include "Template/Template_Endpoint_Control_R.c"\r
\r
-#define TEMPLATE_FUNC_NAME Endpoint_Read_Control_EStream_LE\r
-#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Endpoint_Read_Byte())\r
-#include "Template/Template_Endpoint_Control_R.c"\r
-\r
#define TEMPLATE_FUNC_NAME Endpoint_Read_Control_Stream_BE\r
#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) *BufferPtr = Endpoint_Read_Byte()\r
#include "Template/Template_Endpoint_Control_R.c"\r
\r
-#define TEMPLATE_FUNC_NAME Endpoint_Read_Control_EStream_BE\r
-#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Endpoint_Read_Byte())\r
-#include "Template/Template_Endpoint_Control_R.c"\r
+#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Write_Control_PStream_LE\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) 0\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(pgm_read_byte(BufferPtr))\r
+ #include "Template/Template_Endpoint_Control_W.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Write_Control_PStream_BE\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(pgm_read_byte(BufferPtr))\r
+ #include "Template/Template_Endpoint_Control_W.c"\r
+#endif\r
+\r
+#if defined(ARCH_HAS_EEPROM_ADDRESS_SPACE)\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Write_Control_EStream_LE\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) 0\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(eeprom_read_byte(BufferPtr))\r
+ #include "Template/Template_Endpoint_Control_W.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Write_Control_EStream_BE\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Endpoint_Write_Byte(eeprom_read_byte(BufferPtr))\r
+ #include "Template/Template_Endpoint_Control_W.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Read_Control_EStream_LE\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) 0\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr += Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Endpoint_Read_Byte())\r
+ #include "Template/Template_Endpoint_Control_R.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Endpoint_Read_Control_EStream_BE\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) BufferPtr -= Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Endpoint_Read_Byte())\r
+ #include "Template/Template_Endpoint_Control_R.c"\r
+#endif\r
\r
#endif
/** \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 Endpoint_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 endpoint into the buffer.\r
* \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
\r
/** EEPROM buffer source version of \ref Endpoint_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 endpoint into the buffer.\r
* \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
\r
/** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().\r
*\r
+ * \note This function is not available on all architectures.\r
+ *\r
* \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
* \param[in] Length Number of bytes to send via the currently selected endpoint.\r
* \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
\r
/** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().\r
*\r
+ * \note This function is not available on all architectures.\r
+ *\r
* \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
* \param[in] Length Number of bytes to send via the currently selected endpoint.\r
* \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
* \n\n\r
*\r
* \note This routine should only be used on CONTROL type endpoints.\r
+ * \n\n\r
+ *\r
+ * \note This function is not available on all architectures.\r
*\r
* \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
* together; i.e. the entire stream data must be read or written at the one time.\r
* \n\n\r
*\r
* \note This routine should only be used on CONTROL type endpoints.\r
+ * \n\n\r
+ *\r
+ * \note This function is not available on all architectures.\r
*\r
* \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
* together; i.e. the entire stream data must be read or written at the one time.\r
* \n\n\r
*\r
* \note This routine should only be used on CONTROL type endpoints.\r
+ * \n\n\r
+ *\r
+ * \note This function is not available on all architectures.\r
*\r
* \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
* together; i.e. the entire stream data must be read or written at the one time.\r
* \n\n\r
*\r
* \note This routine should only be used on CONTROL type endpoints.\r
+ * \n\n\r
+ *\r
+ * \note This function is not available on all architectures.\r
*\r
* \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
* together; i.e. the entire stream data must be read or written at the one time.\r
*/\r
uint8_t Endpoint_Read_Control_EStream_BE(void* const Buffer,\r
uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
+ #endif\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 Endpoint_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 endpoint into the buffer.\r
* \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\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 endpoint into the buffer.\r
* \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
* \n\n\r
*\r
* \note This routine should only be used on CONTROL type endpoints.\r
+ * \n\n\r
+ *\r
+ * \note This function is not available on all architectures.\r
*\r
* \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
* together; i.e. the entire stream data must be read or written at the one time.\r
* \n\n\r
*\r
* \note This routine should only be used on CONTROL type endpoints.\r
+ * \n\n\r
+ *\r
+ * \note This function is not available on all architectures.\r
*\r
* \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
* together; i.e. the entire stream data must be read or written at the one time.\r
*/\r
uint8_t Endpoint_Write_Control_PStream_BE(const void* const Buffer,\r
uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
+ #endif\r
//@}\r
\r
/* Disable C linkage for C++ Compilers: */\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(*BufferPtr)\r
#include "Template/Template_Pipe_RW.c"\r
\r
-#define TEMPLATE_FUNC_NAME Pipe_Write_PStream_LE\r
-#define TEMPLATE_BUFFER_TYPE const void*\r
-#define TEMPLATE_TOKEN PIPE_TOKEN_OUT\r
-#define TEMPLATE_CLEAR_PIPE() Pipe_ClearOUT()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream += Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(pgm_read_byte(BufferPtr))\r
-#include "Template/Template_Pipe_RW.c"\r
-\r
-#define TEMPLATE_FUNC_NAME Pipe_Write_EStream_LE\r
-#define TEMPLATE_BUFFER_TYPE const void*\r
-#define TEMPLATE_TOKEN PIPE_TOKEN_OUT\r
-#define TEMPLATE_CLEAR_PIPE() Pipe_ClearOUT()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream += Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(eeprom_read_byte(BufferPtr))\r
-#include "Template/Template_Pipe_RW.c"\r
-\r
#define TEMPLATE_FUNC_NAME Pipe_Write_Stream_BE\r
#define TEMPLATE_BUFFER_TYPE const void*\r
#define TEMPLATE_TOKEN PIPE_TOKEN_OUT\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(*BufferPtr)\r
#include "Template/Template_Pipe_RW.c"\r
\r
-#define TEMPLATE_FUNC_NAME Pipe_Write_PStream_BE\r
-#define TEMPLATE_BUFFER_TYPE const void*\r
-#define TEMPLATE_TOKEN PIPE_TOKEN_OUT\r
-#define TEMPLATE_CLEAR_PIPE() Pipe_ClearOUT()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream -= Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(pgm_read_byte(BufferPtr))\r
-#include "Template/Template_Pipe_RW.c"\r
-\r
-#define TEMPLATE_FUNC_NAME Pipe_Write_EStream_BE\r
-#define TEMPLATE_BUFFER_TYPE const void*\r
-#define TEMPLATE_TOKEN PIPE_TOKEN_OUT\r
-#define TEMPLATE_CLEAR_PIPE() Pipe_ClearOUT()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream -= Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(eeprom_read_byte(BufferPtr))\r
-#include "Template/Template_Pipe_RW.c"\r
-\r
#define TEMPLATE_FUNC_NAME Pipe_Read_Stream_LE\r
#define TEMPLATE_BUFFER_TYPE void*\r
#define TEMPLATE_TOKEN PIPE_TOKEN_IN\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) *BufferPtr = Pipe_Read_Byte()\r
#include "Template/Template_Pipe_RW.c"\r
\r
-#define TEMPLATE_FUNC_NAME Pipe_Read_EStream_LE\r
-#define TEMPLATE_BUFFER_TYPE void*\r
-#define TEMPLATE_TOKEN PIPE_TOKEN_IN\r
-#define TEMPLATE_CLEAR_PIPE() Pipe_ClearIN()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) 0\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream += Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Pipe_Read_Byte())\r
-#include "Template/Template_Pipe_RW.c"\r
-\r
#define TEMPLATE_FUNC_NAME Pipe_Read_Stream_BE\r
#define TEMPLATE_BUFFER_TYPE void*\r
#define TEMPLATE_TOKEN PIPE_TOKEN_IN\r
#define TEMPLATE_TRANSFER_BYTE(BufferPtr) *BufferPtr = Pipe_Read_Byte()\r
#include "Template/Template_Pipe_RW.c"\r
\r
-#define TEMPLATE_FUNC_NAME Pipe_Read_EStream_BE\r
-#define TEMPLATE_BUFFER_TYPE void*\r
-#define TEMPLATE_TOKEN PIPE_TOKEN_IN\r
-#define TEMPLATE_CLEAR_PIPE() Pipe_ClearIN()\r
-#define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
-#define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream -= Amount\r
-#define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Pipe_Read_Byte())\r
-#include "Template/Template_Pipe_RW.c"\r
+#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)\r
+ #define TEMPLATE_FUNC_NAME Pipe_Write_PStream_LE\r
+ #define TEMPLATE_BUFFER_TYPE const void*\r
+ #define TEMPLATE_TOKEN PIPE_TOKEN_OUT\r
+ #define TEMPLATE_CLEAR_PIPE() Pipe_ClearOUT()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) 0\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream += Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(pgm_read_byte(BufferPtr))\r
+ #include "Template/Template_Pipe_RW.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Pipe_Write_PStream_BE\r
+ #define TEMPLATE_BUFFER_TYPE const void*\r
+ #define TEMPLATE_TOKEN PIPE_TOKEN_OUT\r
+ #define TEMPLATE_CLEAR_PIPE() Pipe_ClearOUT()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream -= Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(pgm_read_byte(BufferPtr))\r
+ #include "Template/Template_Pipe_RW.c"\r
+#endif\r
+\r
+#if defined(ARCH_HAS_EEPROM_ADDRESS_SPACE)\r
+ #define TEMPLATE_FUNC_NAME Pipe_Write_EStream_LE\r
+ #define TEMPLATE_BUFFER_TYPE const void*\r
+ #define TEMPLATE_TOKEN PIPE_TOKEN_OUT\r
+ #define TEMPLATE_CLEAR_PIPE() Pipe_ClearOUT()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) 0\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream += Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(eeprom_read_byte(BufferPtr))\r
+ #include "Template/Template_Pipe_RW.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Pipe_Write_EStream_BE\r
+ #define TEMPLATE_BUFFER_TYPE const void*\r
+ #define TEMPLATE_TOKEN PIPE_TOKEN_OUT\r
+ #define TEMPLATE_CLEAR_PIPE() Pipe_ClearOUT()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream -= Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) Pipe_Write_Byte(eeprom_read_byte(BufferPtr))\r
+ #include "Template/Template_Pipe_RW.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Pipe_Read_EStream_LE\r
+ #define TEMPLATE_BUFFER_TYPE void*\r
+ #define TEMPLATE_TOKEN PIPE_TOKEN_IN\r
+ #define TEMPLATE_CLEAR_PIPE() Pipe_ClearIN()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) 0\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream += Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Pipe_Read_Byte())\r
+ #include "Template/Template_Pipe_RW.c"\r
+\r
+ #define TEMPLATE_FUNC_NAME Pipe_Read_EStream_BE\r
+ #define TEMPLATE_BUFFER_TYPE void*\r
+ #define TEMPLATE_TOKEN PIPE_TOKEN_IN\r
+ #define TEMPLATE_CLEAR_PIPE() Pipe_ClearIN()\r
+ #define TEMPLATE_BUFFER_OFFSET(Length) (Length - 1)\r
+ #define TEMPLATE_BUFFER_MOVE(BufferPtr, Amount) DataStream -= Amount\r
+ #define TEMPLATE_TRANSFER_BYTE(BufferPtr) eeprom_update_byte(BufferPtr, Pipe_Read_Byte())\r
+ #include "Template/Template_Pipe_RW.c"\r
+#endif\r
\r
#endif\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
+ * \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
\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
\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
\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
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
+ #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
+ * \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
*\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
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
#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
#endif\r
\r
+ #if !defined(F_USB)\r
+ #error F_USB is not defined. You must define F_USB to the frequency of the clock input to the USB module.\r
+ #endif\r
+\r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
/** \name USB Controller Option Masks */\r
/** \page Page_ConfiguringApps Configuring the Demos, Bootloaders and Projects
*
- * If the target AVR model, clock speed, board or other settings are different from the current settings, they must be changed
- * and the project recompiled from the source code before being programmed into the AVR microcontroller. Most project
- * configuration options are located in the "makefile" build script inside each LUFA application's folder, however some
- * demo or application-specific configuration settings (such as the output format in the AudioOut demo) are located in one or
+ * If the target microcontroller model, architecture, clock speed, board or other settings are different from the current
+ * settings, they must be changed and the project recompiled from the source code before being programmed into the microcontroller.
+ * Most project configuration options are located in the "makefile" build script inside each LUFA application's folder, however
+ * some demo or application-specific configuration settings (such as the output format in the AudioOut demo) are located in one or
* more of the source files of the project. See each project's individual documentation for application-specific configuration
* values.
*
* Inside each makefile, a number of configuration variables are located, with the format "<VARIABLE NAME> = <VALUE>". For
* each application, the important variables which should be altered are:
*
- * - <b>MCU</b>, the target AVR processor
+ * - <b>MCU</b>, the target processor model
+ * - <b>ARCH</b>, the target microcontroller architecture
* - <b>BOARD</b>, the target board hardware
- * - <b>F_USB</b>, the target raw master clock frequency, before any prescaling is performed
- * - <b>F_CPU</b>, the target AVR CPU master clock frequency, after any prescaling
+ * - <b>F_CPU</b>, the target CPU master clock frequency, after any prescaling
+ * - <b>F_USB</b>, the target raw input clock to the USB module of the processor
* - <b>CDEFS</b>, the C preprocessor defines which configure options the source code
* - <b>LUFA_PATH</b>, the path to the LUFA library source code
* - <b>LUFA_OPTS</b>, the compile time LUFA options which configure the library features
* These values should be changed to reflect the build hardware.
*
* \section Sec_MCU The MCU Parameter
- * This parameter indicates the target AVR model for the compiled application. This should be set to the model of the target AVR
- * (such as the AT90USB1287, or the ATMEGA32U4), in all lower-case (e.g. "at90usb1287"). Note that not all demos support all the
- * USB AVR models, as they may make use of peripherals or modes only present in some devices.
+ * This parameter indicates the target microcontroller model for the compiled application. This should be set to the model of the target
+ * microcontroller (such as the AT90USB1287, or the ATMEGA32U4), in all lower-case (e.g. "at90usb1287"). Note that not all demos support all the
+ * microcontroller models and architectures, as they may make use of peripherals or modes only present in some devices.
*
* For supported processor models, see \ref Page_DeviceSupport.
*
+ * \section Sec_ARCH The ARCH Parameter
+ * This parameter indicates the target microcontroller architecture the library is to be compiled for. Different microcontroller
+ * architectures require different source files to be compiled into the final binary, and so this option must be set to the correct
+ * architecture for the selected platform.
+ *
+ * For supported processor architectures, see \ref Page_DeviceSupport.
+ *
* \section Sec_BOARD The BOARD Parameter
- * This parameter indicates the target AVR board hardware for the compiled application. Some LUFA library drivers are board-specific,
+ * This parameter indicates the target board hardware for the compiled application. Some LUFA library drivers are board-specific,
* such as the LED driver, and the library needs to know the layout of the target board. If you are using one of the board models listed
* on the main library page, change this parameter to the board name in all UPPER-case.
*
*
* For boards with built in hardware driver support within the LUFA library, see \ref Page_DeviceSupport.
*
- * \section Sec_F_USB The F_USB Parameter
- * This parameter indicates the target AVR's input clock frequency, in Hz. This is the actual clock input, before any prescaling is performed. In the
- * USB AVR architecture, the input clock before any prescaling is fed directly to the PLL subsystem, and thus the PLL is derived directly from the
- * clock input. The PLL then feeds the USB and other sections of the AVR with the correct upscaled frequencies required for those sections to function.
- *
- * <b>Note that this value does not actually *alter* the AVR's input clock frequency</b>, it is just a way to indicate to the library the clock frequency
- * of the AVR as set by the AVR's fuses. If this value does not reflect the actual running frequency of the AVR, incorrect operation of one of more
- * library components will occur.
- *
* \section Sec_F_CPU The F_CPU Parameter
- * This parameter indicates the target AVR's master CPU clock frequency, in Hz.
+ * This parameter indicates the target microcontroller's main CPU clock frequency, in Hz. This is used by many libraries (and applications) for
+ * timing related purposes, and should reflect the actual CPU speed after any prescaling or adjustments are performed.
*
- * <b>Note that this value does not actually *alter* the AVR's CPU clock frequency</b>, it is just a way to indicate to the library the clock frequency
- * of the AVR core as set by the AVR's fuses. If this value does not reflect the actual running frequency of the AVR, incorrect operation of one of more
- * library components will occur.
+ * \section Sec_F_USB The F_USB Parameter
+ * This parameter indicates the raw input clock frequency to the USB module within the microcontroller in Hz. This may be very different on some platforms
+ * to the main CPU clock or other peripheral/bus clocks.
*
* \section Sec_CDEFS The CDEFS Parameter
* Many applications have features which can be controlled by the defining of specially named preprocessor tokens at the point of compilation - for example,
* \section Sec_LUFA_OPTS The LUFA_OPTS Parameter
* This value is similar to the CDEFS parameter listed elsewhere -- indeed, it is simply a convenient place to group LUFA related tokens away from the
* application's compile time tokens. Normally, these options do not need to be altered to allow an application to compile and run correctly on a
- * different board or AVR to the current configuration - if the options are incorrect, then the demo is most likely incompatible with the chosen USB AVR
- * model and cannot be made to function through the altering of the makefile settings alone (or at all). Settings such as the USB mode (device, host or both),
- * the USB interface speed (Low or Full speed) and other LUFA configuration options can be set here - see \ref Page_TokenSummary documentation for details
+ * different board or microcontroller to the current configuration - if the options are incorrect, then the demo is most likely incompatible with the chosen
+ * microcontroller model and cannot be made to function through the altering of the makefile settings alone (or at all). Settings such as the USB mode
+ * (device, host or both), the USB interface speed and other LUFA configuration options can be set here - see \ref Page_TokenSummary documentation for details
* on the available LUFA compile time configuration options.
*/
projects / pub / USBasp.git / commitdiff