include/setupdat.h

Go to the documentation of this file.

// Copyright (C) 2008 Ubixum, Inc. 
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

#ifndef SETUPDAT_H
#define SETUPDAT_H

#include "fx2regs.h"
#include "delay.h"
// for ease functions

#define STALLEP0() EP0CS |= bmEPSTALL
// to use this, the endpoint needs bit 8 to be IN=1,OUT=0
#define RESETTOGGLE(ep) TOGCTL = (ep&0x0F) + ((ep&0x80)>>3); TOGCTL |= bmRESETTOGGLE
#define RENUMERATE() USBCS|=bmDISCON|bmRENUM;delay(1500);USBCS &= ~bmDISCON

#define SETUP_VALUE() MAKEWORD(SETUPDAT[3],SETUPDAT[2])
#define SETUP_INDEX() MAKEWORD(SETUPDAT[5],SETUPDAT[4])
#define SETUP_LENGTH() MAKEWORD(SETUPDAT[7],SETUPDAT[6]) 



typedef enum {
    GET_STATUS,
    CLEAR_FEATURE,
    // 0x02 is reserved
    SET_FEATURE=0x03,
    // 0x04 is reserved
    SET_ADDRESS=0x05, // this is handled by EZ-USB core unless RENUM=0
    GET_DESCRIPTOR,
    SET_DESCRIPTOR,
    GET_CONFIGURATION,
    SET_CONFIGURATION,
    GET_INTERFACE,
    SET_INTERFACE,
    SYNC_FRAME
} SETUP_DATA;


xdata BYTE* ep_addr(BYTE ep);

/*
 You can call this function directly if you are polling
 for setup data in your main loop.
 You can also use the usbjt and enable the sudav isr
 and call the function from withing the sudav isr routine
*/
void handle_setupdata();


void handle_hispeed();


/* descriptor types */
#define DSCR_DEVICE_TYPE 1
#define DSCR_CONFIG_TYPE 2
#define DSCR_STRING_TYPE 3
#define DSCR_DEVQUAL_TYPE 6
#define DSCR_OTHERSPD_TYPE 7

/* usb spec 2 */
#define DSCR_BCD 2


/* device descriptor */
#define DSCR_DEVICE_LEN 18

typedef struct {
    BYTE dsc_len; // descriptor length (18 for this )
    BYTE dsc_type; // dscr type
    WORD bcd; // bcd
    BYTE dev_class; // device class
    BYTE dev_subclass; // sub class
    BYTE dev_protocol; // sub sub class
    BYTE max_pkt; // max packet size
    WORD vendor_id;
    WORD product_id;
    WORD dev_version; // product version id
    BYTE idx_manstr; //  manufacturer string index
    BYTE idx_devstr; // product string index
    BYTE idx_serstr; // serial number index
    BYTE num_configs; // number of configurations
        
} DEVICE_DSCR;


/* config descriptor */
#define DSCR_CONFIG_LEN 9
typedef struct {
    BYTE dsc_len; // 9 for this one
    BYTE dsc_type; // dscr type
    
} CONFIG_DSCR;

/* string descriptor */
typedef struct {
    BYTE dsc_len;
    BYTE dsc_type;
    BYTE pstr;
} STRING_DSCR;


#endif

---