RNDISClassDevice.h

Go to the documentation of this file.

/*
 * @brief Device mode driver for the library USB RNDIS Class driver
 *
 * @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 _RNDIS_CLASS_DEVICE_H_
#define _RNDIS_CLASS_DEVICE_H_

/* Includes: */
  #include "../../USB.h"
  #include "../Common/RNDISClassCommon.h"

/* Enable C linkage for C++ Compilers: */
  #if defined(__cplusplus)
extern "C" {
  #endif

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

/* Public Interface - May be used in end-application: */
/* Type Defines: */
typedef struct {
 const struct {
  uint8_t  ControlInterfaceNumber;   
  uint8_t  DataINEndpointNumber;    
  uint16_t DataINEndpointSize;   
  bool     DataINEndpointDoubleBank;    
  uint8_t  DataOUTEndpointNumber;    
  uint16_t DataOUTEndpointSize;    
  bool     DataOUTEndpointDoubleBank;    
  uint8_t  NotificationEndpointNumber;   
  uint16_t NotificationEndpointSize;    
  bool     NotificationEndpointDoubleBank;   
  char *AdapterVendorDescription;      
  MAC_Address_t AdapterMACAddress;   
  uint8_t  PortNumber;    
 } Config;    
 struct {
  uint8_t  RNDISMessageBuffer[RNDIS_MESSAGE_BUFFER_SIZE];    
  bool     ResponseReady;    
  uint8_t  CurrRNDISState;   
  uint32_t CurrPacketFilter;    
 } State;   
} USB_ClassInfo_RNDIS_Device_t;

/* Function Prototypes: */
bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

void RNDIS_Device_USBTask(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

bool RNDIS_Device_IsPacketReceived(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo);

uint8_t RNDIS_Device_ReadPacket(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo,
        void *Buffer,
        uint16_t *const PacketLength);

uint8_t RNDIS_Device_SendPacket(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo,
        void *Buffer,
        const uint16_t PacketLength);

/* Private Interface - For use in library only: */
 #if !defined(__DOXYGEN__)
/* Function Prototypes: */
  #if defined(__INCLUDE_FROM_RNDIS_DEVICE_C)
static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo)
ATTR_NON_NULL_PTR_ARG(1);

static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo,
            const uint32_t OId,
            void *const QueryData,
            const uint16_t QuerySize,
            void *ResponseData,
            uint16_t *const ResponseSize) ATTR_NON_NULL_PTR_ARG(1)
ATTR_NON_NULL_PTR_ARG(5) ATTR_NON_NULL_PTR_ARG(6);

static bool RNDIS_Device_ProcessNDISSet(USB_ClassInfo_RNDIS_Device_t *const RNDISInterfaceInfo,
          const uint32_t OId,
          const void *SetData,
          const uint16_t SetSize) ATTR_NON_NULL_PTR_ARG(1)
ATTR_NON_NULL_PTR_ARG(3);

  #endif

 #endif

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

#endif