include/setupdat.h

Go to the documentation of this file.

// Copyright (C) 2009 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"
#define SETUP_VALUE() MAKEWORD(SETUPDAT[3],SETUPDAT[2])
#define SETUP_INDEX() MAKEWORD(SETUPDAT[5],SETUPDAT[4])
#define SETUP_LENGTH() MAKEWORD(SETUPDAT[7],SETUPDAT[6]) 
#define SETUP_TYPE SETUPDAT[0]

extern volatile BOOL self_powered;

extern volatile BOOL remote_wakeup_allowed;


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);

/*
 * \brief Handle the "setup data" USB requests.
 *
 * This function should *not* be called inside an ISR (as it calls
 * non-reentrant functions). Instead you should set a flag inside the ISR and
 * then call this function ASAP as part of your main loop.
 *
 * \code
 * volatile __bit dosud=FALSE;
 * void sudav_isr() __interrupt SUDAV_ISR {
 *     CLEAR_SUDAV();
 *     if(dosud) {
 *         // Indicate error
 *     }
 *     dosud=TRUE;
 * }
 *
 * void main() {
 *     // Other init code
 *     ENABLE_SUDAV();
 *     EA=1; // Enable interrupts
 *
 *     while(TRUE) {
 *         if(dosud) { // Check flag
 *             handle_setupdata();
 *             dosud=FALSE;
 *         }
 *         // Other loop code
 *     }
 * }
 * \endcode
 */
void handle_setupdata();


void handle_hispeed( BOOL highspeed );

/* Descriptor header */
typedef struct {
    BYTE dsc_len;
    BYTE dsc_type;
} HEADER_DSCR;

/* 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
#define DSCR_DEBUG_TYPE 10

/* USB version 2.0 */
#define DSCR_BCD 0x0200

/* Device descriptor */
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;
#define DSCR_DEVICE_LEN 18

/* Config descriptor  */
#define DSCR_CONFIG_LEN 9
#define CONFIG_DSCR DSCR_HEAD

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

#endif