/*********************************************************************

 *

 *                Microchip USB C18 Firmware Version 1.0

 *

 *********************************************************************

 * FileName:        usbdefs_std_dsc.h

 * Dependencies:    See INCLUDES section below

 * Processor:       PIC18

 * Compiler:        C18 2.30.01+

 * Company:         Microchip Technology, Inc.

 *

 * Software License Agreement

 *

 * The software supplied herewith by Microchip Technology Incorporated

 * (the “Company”) for its PICmicro® Microcontroller is intended and

 * supplied to you, the Company’s customer, for use solely and

 * exclusively on Microchip PICmicro Microcontroller products. The

 * software is owned by the Company and/or its supplier, and is

 * protected under applicable copyright laws. All rights are reserved.

 * Any use in violation of the foregoing restrictions may subject the

 * user to criminal sanctions under applicable laws, as well as to

 * civil liability for the breach of the terms and conditions of this

 * license.

 *

 * THIS SOFTWARE IS PROVIDED IN AN “AS IS” CONDITION. NO WARRANTIES,

 * WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED

 * TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

 * PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT,

 * IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR

 * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.

 *

 * Author               Date        Comment

 *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 * Rawin Rojvanit       11/19/04    Original.

 ********************************************************************/

/******************************************************************************

 * USB Definitions: Standard Descriptors

 *****************************************************************************/

#ifndef USBDEFS_STD_DSC_H

#define USBDEFS_STD_DSC_H

/** I N C L U D E S **********************************************************/

#include "typedefs.h"

/** D E F I N I T I O N S ****************************************************/

/* Descriptor Types */

#define DSC_DEV     0x01

#define DSC_CFG     0x02

#define DSC_STR     0x03

#define DSC_INTF    0x04

#define DSC_EP      0x05

/******************************************************************************

 * USB Endpoint Definitions

 * USB Standard EP Address Format: DIR:X:X:X:EP3:EP2:EP1:EP0

 * This is used in the descriptors. See autofiles\usbdsc.c

 * 

 * NOTE: Do not use these values for checking against USTAT.

 * To check against USTAT, use values defined in "system\usb\usbdrv\usbdrv.h"

 *****************************************************************************/

#define _EP01_OUT   0x01

#define _EP01_IN    0x81

#define _EP02_OUT   0x02

#define _EP02_IN    0x82

#define _EP03_OUT   0x03

#define _EP03_IN    0x83

#define _EP04_OUT   0x04

#define _EP04_IN    0x84

#define _EP05_OUT   0x05

#define _EP05_IN    0x85

#define _EP06_OUT   0x06

#define _EP06_IN    0x86

#define _EP07_OUT   0x07

#define _EP07_IN    0x87

#define _EP08_OUT   0x08

#define _EP08_IN    0x88

#define _EP09_OUT   0x09

#define _EP09_IN    0x89

#define _EP10_OUT   0x0A

#define _EP10_IN    0x8A

#define _EP11_OUT   0x0B

#define _EP11_IN    0x8B

#define _EP12_OUT   0x0C

#define _EP12_IN    0x8C

#define _EP13_OUT   0x0D

#define _EP13_IN    0x8D

#define _EP14_OUT   0x0E

#define _EP14_IN    0x8E

#define _EP15_OUT   0x0F

#define _EP15_IN    0x8F

/* Configuration Attributes */

#define _DEFAULT    0x01<<7         //Default Value (Bit 7 is set)

#define _SELF       0x01<<6         //Self-powered (Supports if set)

#define _RWU        0x01<<5         //Remote Wakeup (Supports if set)

/* Endpoint Transfer Type */

#define _CTRL       0x00            //Control Transfer

#define _ISO        0x01            //Isochronous Transfer

#define _BULK       0x02            //Bulk Transfer

#define _INT        0x03            //Interrupt Transfer

/* Isochronous Endpoint Synchronization Type */

#define _NS         0x00<<2         //No Synchronization

#define _AS         0x01<<2         //Asynchronous

#define _AD         0x02<<2         //Adaptive

#define _SY         0x03<<2         //Synchronous

/* Isochronous Endpoint Usage Type */

#define _DE         0x00<<4         //Data endpoint

#define _FE         0x01<<4         //Feedback endpoint

#define _IE         0x02<<4         //Implicit feedback Data endpoint

/** S T R U C T U R E ********************************************************/

/******************************************************************************

 * USB Device Descriptor Structure

 *****************************************************************************/

typedef struct _USB_DEV_DSC

{

    byte bLength;       byte bDscType;      word bcdUSB;

    byte bDevCls;       byte bDevSubCls;    byte bDevProtocol;

    byte bMaxPktSize0;  word idVendor;      word idProduct;

    word bcdDevice;     byte iMFR;          byte iProduct;

    byte iSerialNum;    byte bNumCfg;

} USB_DEV_DSC;

/******************************************************************************

 * USB Configuration Descriptor Structure

 *****************************************************************************/

typedef struct _USB_CFG_DSC

{

    byte bLength;       byte bDscType;      word wTotalLength;

    byte bNumIntf;      byte bCfgValue;     byte iCfg;

    byte bmAttributes;  byte bMaxPower;

} USB_CFG_DSC;

/******************************************************************************

 * USB Interface Descriptor Structure

 *****************************************************************************/

typedef struct _USB_INTF_DSC

{

    byte bLength;       byte bDscType;      byte bIntfNum;

    byte bAltSetting;   byte bNumEPs;       byte bIntfCls;

    byte bIntfSubCls;   byte bIntfProtocol; byte iIntf;

} USB_INTF_DSC;

/******************************************************************************

 * USB Endpoint Descriptor Structure

 *****************************************************************************/

typedef struct _USB_EP_DSC

{

    byte bLength;       byte bDscType;      byte bEPAdr;

    byte bmAttributes;  word wMaxPktSize;   byte bInterval;

} USB_EP_DSC;

#endif //USBDEFS_STD_DSC_H