Endpoint.h

Go to the documentation of this file.

/*
 * @brief USB Endpoint definitions for all architectures
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * Copyright(C) Dean Camera, 2011, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __ENDPOINT_H__
#define __ENDPOINT_H__

 /* Includes: */
  #include "../../../Common/Common.h"
  #include "USBMode.h"
  #include "USBTask.h"
  #include "USBInterrupt.h"
  
 /* Enable C linkage for C++ Compilers: */
  #if defined(__cplusplus)
   extern "C" {
  #endif

 /* Preprocessor Checks: */
  #if !defined(__INCLUDE_FROM_USB_DRIVER)
   #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
  #endif

 /* Public Interface - May be used in end-application: */
  /* Macros: */
   #define ENDPOINT_EPNUM_MASK                     0x0F

   #define ENDPOINT_CONTROLEP                      0
    
   #if defined(__LPC18XX__) || defined(__LPC43XX__)
    #include "DCD/LPC18XX/Endpoint_LPC18xx.h"
   #elif defined(__LPC175X_6X__) || defined(__LPC177X_8X__) || defined(__LPC407X_8X__)
    #include "DCD/LPC17XX/Endpoint_LPC17xx.h"
   #elif defined(__LPC11U1X__) || defined(__LPC11U2X_3X__) || defined(__LPC1347__)
    #include "DCD/LPC11UXX/Endpoint_LPC11Uxx.h"
   #endif
   

   
   #define ENDPOINT_BANK_SINGLE                    (0 << 1)
   
   #define ENDPOINT_BANK_DOUBLE                    (1 << 1)
   
   #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))

   #define ENDPOINT_CONTROLEP_DEFAULT_SIZE     64
   #endif
   
   #define ENDPOINT_MAX_SIZE(EPIndex)              512
   
   #if !defined(CONTROL_ONLY_DEVICE) || defined(__DOXYGEN__)

   #define ENDPOINT_TOTAL_ENDPOINTS0            ENDPOINT_DETAILS_MAXEP0
   #define ENDPOINT_TOTAL_ENDPOINTS1            ENDPOINT_DETAILS_MAXEP1
   #define ENDPOINT_TOTAL_ENDPOINTS(corenum)   ((corenum) ? ENDPOINT_DETAILS_MAXEP1 : ENDPOINT_DETAILS_MAXEP0)
   #else
   #define ENDPOINT_TOTAL_ENDPOINTS            1
   #endif
   
   /* Enums: */
   enum Endpoint_WaitUntilReady_ErrorCodes_t {
    ENDPOINT_READYWAIT_NoError                 = 0, 
    ENDPOINT_READYWAIT_EndpointStalled         = 1, 
    ENDPOINT_READYWAIT_DeviceDisconnected      = 2, 
    ENDPOINT_READYWAIT_BusSuspended            = 3, 
    ENDPOINT_READYWAIT_Timeout                 = 4, 
   };
   
   PRAGMA_ALWAYS_INLINE
   static inline uint8_t Endpoint_GetCurrentEndpoint(uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

   static inline uint8_t Endpoint_GetCurrentEndpoint(uint8_t corenum)
   {
    return endpointselected[corenum];
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline void Endpoint_SelectEndpoint(uint8_t corenum, const uint8_t EndpointNumber) ATTR_ALWAYS_INLINE;

   static inline void Endpoint_SelectEndpoint(uint8_t corenum, const uint8_t EndpointNumber)
   {
    endpointselected[corenum] = EndpointNumber;
    // usb_data_buffer_index = 0;
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline uint8_t Endpoint_Read_8(uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

   static inline uint8_t Endpoint_Read_8(uint8_t corenum)
   {
    uint8_t tem;
    if (endpointselected[corenum] == ENDPOINT_CONTROLEP) {
     tem = usb_data_buffer[corenum][usb_data_buffer_index[corenum]];
     usb_data_buffer_index[corenum]++;
     usb_data_buffer_size[corenum]--;
    }
    else {
     tem = usb_data_buffer_OUT[corenum][usb_data_buffer_OUT_index[corenum]];
     usb_data_buffer_OUT_index[corenum]++;
     usb_data_buffer_OUT_size[corenum]--;
    }
    return tem;
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline uint8_t Endpoint_GetEndpointDirection(uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

   static inline uint8_t Endpoint_GetEndpointDirection(uint8_t corenum)
   {
    return (endpointhandle(corenum)[endpointselected[corenum]] % 2) ? ENDPOINT_DIR_IN : ENDPOINT_DIR_OUT;
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline bool Endpoint_IsReadWriteAllowed(uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

   static inline bool Endpoint_IsReadWriteAllowed(uint8_t corenum)
   {
    return (Endpoint_GetEndpointDirection(corenum) == ENDPOINT_DIR_OUT) ? Endpoint_IsOUTReceived(corenum) : Endpoint_IsINReady(corenum);
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline void Endpoint_Write_8(uint8_t corenum, const uint8_t Data) ATTR_ALWAYS_INLINE;

   static inline void Endpoint_Write_8(uint8_t corenum, const uint8_t Data)
   {
    if (endpointselected[corenum] == ENDPOINT_CONTROLEP) {
     usb_data_buffer[corenum][usb_data_buffer_index[corenum]] = Data;
     usb_data_buffer_index[corenum]++;
    }
    else {
     usb_data_buffer_IN[corenum][usb_data_buffer_IN_index[corenum]] = Data;
     usb_data_buffer_IN_index[corenum]++;
    }
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline void Endpoint_Discard_8(uint8_t corenum) ATTR_ALWAYS_INLINE;

   static inline void Endpoint_Discard_8(uint8_t corenum)
   {
    volatile uint8_t dummy;
    dummy = Endpoint_Read_8(corenum);
    dummy = dummy;
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline uint16_t Endpoint_Read_16_LE(uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

   static inline uint16_t Endpoint_Read_16_LE(uint8_t corenum)
   {
    uint16_t tem = 0;
    uint8_t tem1, tem2;

    tem1 = Endpoint_Read_8(corenum);
    tem2 = Endpoint_Read_8(corenum);
    tem = (tem2 << 8) | tem1;
    return tem;
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline uint16_t Endpoint_Read_16_BE(uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

   static inline uint16_t Endpoint_Read_16_BE(uint8_t corenum)
   {
    uint16_t tem = 0;
    uint8_t tem1, tem2;

    tem1 = Endpoint_Read_8(corenum);
    tem2 = Endpoint_Read_8(corenum);
    tem = (tem1 << 8) | tem2;
    return tem;
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline void Endpoint_Write_16_LE(uint8_t corenum, const uint16_t Data) ATTR_ALWAYS_INLINE;

   static inline void Endpoint_Write_16_LE(uint8_t corenum, const uint16_t Data)
   {
    Endpoint_Write_8(corenum, Data & 0xFF);
    Endpoint_Write_8(corenum, (Data >> 8) & 0xFF);
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline void Endpoint_Write_16_BE(uint8_t corenum, const uint16_t Data) ATTR_ALWAYS_INLINE;

   static inline void Endpoint_Write_16_BE(uint8_t corenum, const uint16_t Data)
   {
    Endpoint_Write_8(corenum, (Data >> 8) & 0xFF);
    Endpoint_Write_8(corenum, Data & 0xFF);
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline void Endpoint_Discard_16(uint8_t corenum) ATTR_ALWAYS_INLINE;

   static inline void Endpoint_Discard_16(uint8_t corenum)
   {
    uint8_t tem;
    tem = Endpoint_Read_8(corenum);
    tem = Endpoint_Read_8(corenum);
    tem  = tem;
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline uint32_t Endpoint_Read_32_LE(uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

   static inline uint32_t Endpoint_Read_32_LE(uint8_t corenum)
   {
    uint32_t tem = 0;
    uint8_t tem1, tem2, tem3, tem4;

    tem1 = Endpoint_Read_8(corenum);
    tem2 = Endpoint_Read_8(corenum);
    tem3 = Endpoint_Read_8(corenum);
    tem4 = Endpoint_Read_8(corenum);
    tem = (tem4 << 24) | (tem3 << 16) | (tem2 << 8) | tem1;
    return tem;
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline uint32_t Endpoint_Read_32_BE(uint8_t corenum) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;

   static inline uint32_t Endpoint_Read_32_BE(uint8_t corenum)
   {
    uint32_t tem = 0;
    uint8_t tem1, tem2, tem3, tem4;

    tem1 = Endpoint_Read_8(corenum);
    tem2 = Endpoint_Read_8(corenum);
    tem3 = Endpoint_Read_8(corenum);
    tem4 = Endpoint_Read_8(corenum);
    tem = (tem1 << 24) | (tem2 << 16) | (tem3 << 8) | tem4;
    return tem;
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline void Endpoint_Write_32_LE(uint8_t corenum, const uint32_t Data) ATTR_ALWAYS_INLINE;

   static inline void Endpoint_Write_32_LE(uint8_t corenum, const uint32_t Data)
   {
    Endpoint_Write_8(corenum, Data & 0xFF);
    Endpoint_Write_8(corenum, (Data >> 8) & 0xFF);
    Endpoint_Write_8(corenum, (Data >> 16) & 0xFF);
    Endpoint_Write_8(corenum, (Data >> 24) & 0xFF);
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline void Endpoint_Write_32_BE(uint8_t corenum, const uint32_t Data) ATTR_ALWAYS_INLINE;

   static inline void Endpoint_Write_32_BE(uint8_t corenum, const uint32_t Data)
   {
    Endpoint_Write_8(corenum, (Data >> 24) & 0xFF);
    Endpoint_Write_8(corenum, (Data >> 16) & 0xFF);
    Endpoint_Write_8(corenum, (Data >> 8) & 0xFF);
    Endpoint_Write_8(corenum, Data & 0xFF);
   }
   
   PRAGMA_ALWAYS_INLINE
   static inline void Endpoint_Discard_32(uint8_t corenum) ATTR_ALWAYS_INLINE;

   static inline void Endpoint_Discard_32(uint8_t corenum)
   {
    uint8_t tem;
    tem = Endpoint_Read_8(corenum);
    tem = Endpoint_Read_8(corenum);
    tem = Endpoint_Read_8(corenum);
    tem = Endpoint_Read_8(corenum);
    tem = tem;
   }
   
   void Endpoint_GetSetupPackage(uint8_t corenum, uint8_t *pData);


 /* Disable C linkage for C++ Compilers: */
  #if defined(__cplusplus)
   }
  #endif

#endif