USBRequests.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------- */
/*                  Atmel Microcontroller Software Support                      */
/*                       SAM Software Package License                           */
/* ---------------------------------------------------------------------------- */
/* Copyright (c) 2015, Atmel Corporation                                        */
/*                                                                              */
/* All rights reserved.                                                         */
/*                                                                              */
/* Redistribution and use in source and binary forms, with or without           */
/* modification, are permitted provided that the following condition is met:    */
/*                                                                              */
/* - Redistributions of source code must retain the above copyright notice,     */
/* this list of conditions and the disclaimer below.                            */
/*                                                                              */
/* Atmel's name may not be used to endorse or promote products derived from     */
/* this software without specific prior written permission.                     */
/*                                                                              */
/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
/* ---------------------------------------------------------------------------- */

#ifndef _USBREQUESTS_H_
#define _USBREQUESTS_H_

/*---------------------------------------------------------------------------
 *      Headers
 *---------------------------------------------------------------------------*/

/* These headers were introduced in C99 by working group
 * ISO/IEC JTC1/SC22/WG14.
 */
#include <stdint.h>

/*---------------------------------------------------------------------------
 *      Definitions
 *---------------------------------------------------------------------------*/

/*----------- Generic Request ------------*/

#define USBGenericRequest_GETSTATUS             0

#define USBGenericRequest_CLEARFEATURE          1

#define USBGenericRequest_SETFEATURE            3

#define USBGenericRequest_SETADDRESS            5

#define USBGenericRequest_GETDESCRIPTOR         6

#define USBGenericRequest_SETDESCRIPTOR         7

#define USBGenericRequest_GETCONFIGURATION      8

#define USBGenericRequest_SETCONFIGURATION      9

#define USBGenericRequest_GETINTERFACE          10

#define USBGenericRequest_SETINTERFACE          11

#define USBGenericRequest_SYNCHFRAME            12

#define USBGenericRequest_DEVICE                0

#define USBGenericRequest_INTERFACE             1

#define USBGenericRequest_ENDPOINT              2

#define USBGenericRequest_OTHER                 3

#define USBGenericRequest_STANDARD              0

#define USBGenericRequest_CLASS                 1

#define USBGenericRequest_VENDOR                2

#define USBGenericRequest_OUT                   0

#define USBGenericRequest_IN                    1

/*----------- Feature Request ------------*/

#define USBFeatureRequest_ENDPOINTHALT          0

#define USBFeatureRequest_DEVICEREMOTEWAKEUP    1

#define USBFeatureRequest_TESTMODE              2

#define USBFeatureRequest_OTG                0x0B

#define USBFeatureRequest_OTG_B_HNP_ENABLE      3

#define USBFeatureRequest_OTG_A_HNP_SUPPORT     4

#define USBFeatureRequest_OTG_A_ALT_HNP_SUPPORT 5

#define USBFeatureRequest_TESTJ                 1

#define USBFeatureRequest_TESTK                 2

#define USBFeatureRequest_TESTSE0NAK            3

#define USBFeatureRequest_TESTPACKET            4

#define USBFeatureRequest_TESTFORCEENABLE       5

#define USBFeatureRequest_TESTSENDZLP           6

/*---------------------------------------------------------------------------
 *      Types
 *---------------------------------------------------------------------------*/
typedef uint8_t USBHS_Add_t;
typedef uint8_t USBHS_Ep_t;
/* 
 *          Function types
 */

/* 
 *          Descriptor structs types
 */
#pragma pack(1)
#if defined   ( __CC_ARM   ) /* Keil ¦ÌVision 4 */
#elif defined ( __ICCARM__ ) /* IAR Ewarm 5.41+ */
#define __attribute__(...)
#elif defined (  __GNUC__  ) /* GCC CS3 2009q3-68 */
#endif

typedef struct {

    uint8_t bmRequestType:8;
    uint8_t bRequest:8;
    uint16_t wValue:16;
    uint16_t wIndex:16;
    uint16_t wLength:16;

} USBGenericRequest;

#pragma pack()

/*---------------------------------------------------------------------------
 *      Exported Functions
 *---------------------------------------------------------------------------*/

extern uint8_t USBGenericRequest_GetType(
    const USBGenericRequest *request);

extern uint8_t USBGenericRequest_GetRequest(
    const USBGenericRequest *request);

extern uint16_t USBGenericRequest_GetValue(
    const USBGenericRequest *request);

extern uint16_t USBGenericRequest_GetIndex(
    const USBGenericRequest *request);

extern uint16_t USBGenericRequest_GetLength(
    const USBGenericRequest *request);

extern uint8_t USBGenericRequest_GetEndpointNumber(
    const USBGenericRequest *request);

extern uint8_t USBGenericRequest_GetRecipient(
    const USBGenericRequest *request);

extern uint8_t USBGenericRequest_GetDirection(
    const USBGenericRequest *request);


extern uint8_t USBGetDescriptorRequest_GetDescriptorType(
    const USBGenericRequest *request);

extern uint8_t USBGetDescriptorRequest_GetDescriptorIndex(
    const USBGenericRequest *request);


extern uint8_t USBSetAddressRequest_GetAddress(
    const USBGenericRequest *request);


extern uint8_t USBSetConfigurationRequest_GetConfiguration(
    const USBGenericRequest *request);


extern uint8_t USBInterfaceRequest_GetInterface(
    const USBGenericRequest *request);

extern uint8_t USBInterfaceRequest_GetAlternateSetting(
    const USBGenericRequest *request);


extern uint8_t USBFeatureRequest_GetFeatureSelector(
    const USBGenericRequest *request);

extern uint8_t USBFeatureRequest_GetTestSelector(
    const USBGenericRequest *request);

#endif /* #ifndef _USBREQUESTS_H_ */