USBRequests.c

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.                           */
/* ---------------------------------------------------------------------------- */

/*------------------------------------------------------------------------------
 *         Headers
 *------------------------------------------------------------------------------*/
#include <USBRequests.h>

/*------------------------------------------------------------------------------
 *         Exported functions
 *------------------------------------------------------------------------------*/

extern uint8_t USBGenericRequest_GetType(const USBGenericRequest *request)
{
        return ((request->bmRequestType >> 5) & 0x3);
}

uint8_t USBGenericRequest_GetRequest(const USBGenericRequest *request)
{
        return request->bRequest;
}

uint16_t USBGenericRequest_GetValue(const USBGenericRequest *request)
{
        return request->wValue;
}

uint16_t USBGenericRequest_GetIndex(const USBGenericRequest *request)
{
        return request->wIndex;
}

uint16_t USBGenericRequest_GetLength(const USBGenericRequest *request)
{
        return request->wLength;
}

uint8_t USBGenericRequest_GetEndpointNumber(
        const USBGenericRequest *request)
{
        return USBGenericRequest_GetIndex(request) & 0xF;
}

uint8_t USBGenericRequest_GetRecipient(const USBGenericRequest *request)
{
        /* Recipient is in bits [0..4] of the bmRequestType field */
        return request->bmRequestType & 0xF;
}

uint8_t USBGenericRequest_GetDirection(const USBGenericRequest *request)
{
        /* Transfer direction is located in bit D7 of the bmRequestType field */
        if ((request->bmRequestType & 0x80) != 0)
                return USBGenericRequest_IN;
        else
                return USBGenericRequest_OUT;
}


uint8_t USBGetDescriptorRequest_GetDescriptorType(
        const USBGenericRequest *request)
{
        /* Requested descriptor type is in the high-byte of the wValue field */
        return (USBGenericRequest_GetValue(request) >> 8) & 0xFF;
}

uint8_t USBGetDescriptorRequest_GetDescriptorIndex(
        const USBGenericRequest *request)
{
        /* Requested descriptor index if in the low byte of the wValue field */
        return USBGenericRequest_GetValue(request) & 0xFF;
}


uint8_t USBSetAddressRequest_GetAddress(const USBGenericRequest *request)
{
        return USBGenericRequest_GetValue(request) & 0x7F;
}


uint8_t USBSetConfigurationRequest_GetConfiguration(
        const USBGenericRequest *request)
{
        return USBGenericRequest_GetValue(request);
}


uint8_t USBInterfaceRequest_GetInterface(const USBGenericRequest *request)
{
        return (USBGenericRequest_GetIndex(request) & 0xFF);
}

uint8_t USBInterfaceRequest_GetAlternateSetting(
        const USBGenericRequest *request)
{
        return (USBGenericRequest_GetValue(request) & 0xFF);
}


uint8_t USBFeatureRequest_GetFeatureSelector(
        const USBGenericRequest *request)
{
        return USBGenericRequest_GetValue(request);
}

uint8_t USBFeatureRequest_GetTestSelector(
        const USBGenericRequest *request)
{
        return (USBGenericRequest_GetIndex(request) >> 8) & 0xFF;
}