/*******************************************************************************
File Information:
FileName: usb_function_ccid.h
Dependencies: See INCLUDES section
Processor: PIC18 or PIC24 USB Microcontrollers
Hardware: The code is natively intended to be used on the following
hardware platforms: PICDEM FS USB Demo Board,
PIC18F87J50 FS USB Plug-In Module, or
Explorer 16 + PIC24 USB PIM. The firmware may be
modified for use on other USB platforms by editing the
HardwareProfile.h file.
Complier: Microchip C18 (for PIC18) or C30 (for PIC24)
Company: Microchip Technology, Inc.
Software License Agreement:
The software supplied herewith by Microchip Technology Incorporated
(the Company) for its PIC® Microcontroller is intended and
supplied to you, the Companys customer, for use solely and
exclusively on Microchip PIC 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.
Change History:
Rev Date Description
0.1 2/June/2009 Draft
Summary:
This file contains all of functions, macros, definitions, variables,
datatypes, etc. that are required for usage with the AUDIO function
driver. This file should be included in projects that use the Audio
\function driver. This file should also be included into the
usb_descriptors.c file and any other user file that requires access to the
HID interface.
This file is located in the "\<Install Directory\>\\Microchip\\Include\\USB"
directory.
Description:
USB AUDIO Function Driver File
This file contains all of functions, macros, definitions, variables,
datatypes, etc. that are required for usage with the AUDIO function
driver. This file should be included in projects that use the AUDIO
\function driver. This file should also be included into the
usb_descriptors.c file and any other user file that requires access to the
AUDIO interface.
This file is located in the "\<Install Directory\>\\Microchip\\Include\\USB"
directory.
When including this file in a new project, this file can either be
referenced from the directory in which it was installed or copied
directly into the user application folder. If the first method is
chosen to keep the file located in the folder in which it is installed
then include paths need to be added so that the library and the
application both know where to reference each others files. If the
application folder is located in the same folder as the Microchip
folder (like the current demo folders), then the following include
paths need to be added to the application's project:
.
..\\..\\Microchip\\Include
If a different directory structure is used, modify the paths as
required. An example using absolute paths instead of relative paths
would be the following:
C:\\Microchip Solutions\\Microchip\\Include
C:\\Microchip Solutions\\My Demo Application
*******************************************************************/
/********************************************************************
Change History:
Rev Description
---- -----------
2.6 Initial Release
2.6a- No Change
2.7a
********************************************************************/
#ifndef CCID_H
#define CCID_H
/** I N C L U D E S *******************************************************/
/** DEFINITIONS ****************************************************/
/* CCID Bulk OUT transfer states */
#define USB_CCID_BULK_OUT_FIRST_PACKET 0
#define USB_CCID_BULK_OUT_SUBSEQUENT_PACKET 1
/* CCID Bulk IN transfer states */
#define USB_CCID_BULK_IN_READY 0
#define USB_CCID_BULK_IN_BUSY 1
#define USB_CCID_BULK_IN_BUSY_ZLP 2 // ZLP: Zero Length Packet
#define USB_CCID_BULK_IN_COMPLETING 3
/****** CCID Class-Specific Request Codes ************/
#define USB_CCID_ABORT 0x01
#define USB_CCID_GET_CLOCK_FREQUENCIES 0x02
#define USB_CCID_GET_DATA_RATES 0x03
// CCID Commands/response
#define USB_CCID_PC_TO_RDR_ICC_POWER_ON 0x62
#define USB_CCID_PC_TO_RDR_ICC_POWER_OFF 0x63
#define USB_CCID_PC_TO_RDR_GET_SLOT_STATUS 0x65
#define USB_CCID_PC_TO_RDR_XFR_BLOCK 0x6F
#define USB_CCID_PC_TO_RDR_GET_PARAMETERS 0x6C
#define USB_CCID_PC_TO_RDR_RESET_PARAMETERS 0x6D
#define USB_CCID_PC_TO_RDR_SET_PARAMETERS 0x61
#define USB_CCID_PC_TO_RDR_ESCAPE 0x6B
#define USB_CCID_PC_TO_RDR_ICC_CLOCK 0x6E
#define USB_CCID_PC_TO_RDR_T0APDU 0x6A
#define USB_CCID_PC_TO_RDR_SECURE 0x69
#define USB_CCID_PC_TO_RDR_MECHANICAL 0x71
#define USB_CCID_PC_TO_RDR_ABORT 0x72
#define USB_CCID_PC_TO_RDR_SET_DATA_RATE_AND_CLOCK_FREQUENCY 0x73
#define USB_CCID_RDR_TO_PC_DATA_BLOCK 0x80
#define USB_CCID_RDR_TO_PC_SLOT_STATUS 0x81
#define USB_CCID_RDR_TO_PC_PARAMETERS 0x82
#define USB_CCID_RDR_TO_PC_ESCAPE 0x83
#define USB_CCID_RDR_TO_PC_DATA_RATE_AND_CLOCK_FREQUENCY 0x84
//CCID Errors
#define USB_CCID_CMD_ABORTED 0xFF
#define USB_CCID_ICC_MUTE 0xFE
#define USB_CCID_XFR_PARITY_ERROR 0xFD
#define USB_CCID_XFR_OVERRUN 0xFC
#define USB_CCID_HW_ERROR 0xFB
#define USB_CCID_BAD_ATR_TS 0xF8
#define USB_CCID_BAD_ATR_TCK 0xF7
#define USB_CCID_ICC_PROTOCOL_NOT_SUPPORTED 0xF6
#define USB_CCID_ICC_CLASS_NOT_SUPPORTED 0xF5
#define USB_CCID_PROCEDURE_BYTE_CONFLICT 0xF4
#define USB_CCID_DEACTIVATED_PROTOCOL 0xF3
#define USB_CCID_BUSY_WITH_AUTO_SEQUENCE 0xF2
#define USB_CCID_PIN_TIMEOUT 0xF0
#define USB_CCID_PIN_CANCELLED 0xEF
#define USB_CCID_CMD_SLOT_BUSY 0xE0
#define USB_CCID_CMD_NOT_SUPPORTED 0x00
/******************************************************************************
Function:
void mUSBCCIDBulkInRam(BYTE *pData, BYTE len)
Description:
Use this macro to transfer data located in data memory.
Use this macro when:
1. Data stream is not null-terminated
2. Transfer length is known
Remember: usbCcidBulkInTrfState must == USB_CCID_BULK_IN_READY
Unexpected behavior will occur if this function is called when
usbCcidBulkInTrfState != USB_CCID_BULK_IN_READY
PreCondition:
usbCcidBulkInTrfState must be in the USB_CCID_BULK_IN_READY state.
Paramters:
pDdata : Pointer to the starting location of data bytes
len : Number of bytes to be transferred
Return Values:
None
Remarks:
This macro only handles the setup of the transfer. The
actual transfer is handled by USBCCIDBulkInService().
*****************************************************************************/
#define mUSBCCIDBulkInRam(pData,len) \
{ \
pCCIDSrc.bRam = pData; \
usbCcidBulkInLen = len; \
usbCcidBulkInTrfState = USB_CCID_BULK_IN_BUSY; \
}
/** E X T E R N S ************************************************************/
extern volatile CTRL_TRF_SETUP SetupPkt;
extern USB_HANDLE usbCcidBulkOutHandle;
extern USB_HANDLE usbCcidBulkInHandle;
extern USB_HANDLE usbCcidInterruptInHandle;
extern unsigned char usbCcidBulkOutEndpoint[USB_EP_SIZE]; //User application buffer for receiving and holding OUT packets sent from the host
extern unsigned char usbCcidBulkInEndpoint[USB_EP_SIZE]; //User application buffer for sending IN packets to the host
/** Section: PUBLIC PROTOTYPES **********************************************/
void USBCheckCCIDRequest(void);
void USBCCIDInitEP(void);
void USBCCIDBulkInService(void);
void USBCCIDSendDataToHost(BYTE *pData, WORD len);
/** Section: STRUCTURES **********************************************/
typedef union {
BYTE CCID_BulkOutBuffer[271];
BYTE CCID_BulkInBuffer[267];
} USB_CCID_BUFFER;
#endif //CCID_H
|