conf_usb.h

Go to the documentation of this file.

/*This file is prepared for Doxygen automatic documentation generation.*/

/* Copyright (c) 2009 Atmel Corporation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The name of Atmel may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * 4. This software may only be redistributed and used in connection with an Atmel
 * AVR product.
 *
 * 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 EXPRESSLY AND
 * SPECIFICALLY 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.
 */
#ifndef _CONF_USB_H_
#define _CONF_USB_H_


#include "modules/usb/usb_commun.h"
#include "modules/usb/usb_commun_hid.h"
#include "modules/usb/usb_commun_ms.h"



   // _________________ USB MODE CONFIGURATION ____________________________
   //

      #define USB_HOST_FEATURE            ENABLED

      #define USB_DEVICE_FEATURE          ENABLED


   // _________________ USB REGULATOR CONFIGURATION _______________________
   //

#ifndef USE_USB_PADS_REGULATOR
   #define USE_USB_PADS_REGULATOR   ENABLE      // Possible values ENABLE or DISABLE
#endif

   // _________________ HOST MODE CONFIGURATION ____________________________
   //

#define PIPE_MOUSE_IN  pipe_mouse_in
#define PIPE_HID_IN    pipe_hid_in
#define PIPE_HID_OUT   pipe_hid_out

extern U8  pipe_mouse_in;

extern U8 dfu_connected;
#define Is_dfu_connected()          (  dfu_connected ? TRUE : FALSE )
extern U8 hid_connected;
#define Is_hid_connected()          (  (hid_connected && Is_host_not_suspended()) ? TRUE : FALSE )


   #define VID_PID_TABLE            {VID_ATMEL, 2, PID_MegaHIDMouse, 0x2014 \
                                    ,0x0123, 3, 0x2000, 0x2100, 0x1258}

   #define CLASS_SUBCLASS_PROTOCOL     {\
                                       0x00, 0x00, 0x00,\
                                       HUB_CLASS, 0x00, 0x00,\
                                       MS_CLASS, MS_SUB_CLASS2, MS_PROTOCOL,\
                                       MS_CLASS, MS_SUB_CLASS5, MS_PROTOCOL,\
                                       MS_CLASS, MS_SUB_CLASS6, MS_PROTOCOL,\
                                       HID_CLASS, NO_SUBCLASS, HID_PROTOCOL_MOUSE,\
                                       HID_CLASS, HID_SUB_CLASS_BOOT, HID_PROTOCOL_MOUSE,\
                                       HID_CLASS, NO_SUBCLASS, NO_PROTOCOL,\
                                       }

   #define SIZEOF_DATA_STAGE        250

   #define DEVICE_BASE_ADDRESS      0x05

   #define MAX_EP_PER_INTERFACE     3

   #define MAX_INTERFACE_FOR_DEVICE 3

   #define MAX_DEVICE_IN_USB_TREE   4

#define SAVE_INTERRUPT_PIPE_FOR_DMS_INTERFACE   ENABLE

#if (MAX_DEVICE_IN_USB_TREE>1)
   #define USB_HUB_SUPPORT          ENABLE
   #define USB_MAX_HUB_NUMBER       4
   #define HUB_MAX_NB_PORT          4
#else
   #define USB_HUB_SUPPORT          DISABLE
#endif

   #define HOST_STRICT_VID_PID_TABLE      DISABLE

   #define HOST_AUTO_CFG_ENDPOINT         ENABLE

   #define HOST_CONTINUOUS_SOF_INTERRUPT  DISABLE

   #define HOST_ERROR_RESTART             ENABLE

   #define USB_HOST_PIPE_INTERRUPT_TRANSFER  ENABLE

   #define ID_PIN_CHANGE_GENERATE_RESET   DISABLE

   #define TIMEOUT_DELAY_ENABLE           ENABLE

   #define TIMEOUT_DELAY               10

   #define NAK_TIMEOUT_ENABLE          DISABLE

   #define NAK_SEND_TIMEOUT            0x0FFF

   #define NAK_RECEIVE_TIMEOUT         0x0FFF

   #define SOFTWARE_VBUS_CTRL          ENABLE

   #if (HOST_AUTO_CFG_ENDPOINT==FALSE)
      #define        User_configure_endpoint()
   #endif

   // write here the action to associate to each USB host event
   // be carefull not to waste time in order not disturbing the functions
   #define Usb_id_transition_action()
   #define Host_device_disconnection_action()
   #define Host_device_connection_action()
   #define Host_sof_action()                          host_sof_action()
   #define Host_suspend_action()
   #define Host_hwup_action()
   #define Host_device_not_supported_action()
   #define Host_device_class_not_supported_action()
   #define Host_device_supported_action()
   #define Host_device_error_action()

extern void set_power_down_mode(void);
extern void host_sof_action(void);


// _________________ DEVICE MODE CONFIGURATION __________________________


#define USB_DEVICE_SN_USE          ENABLE             // Must be enable to see all disks under Windows in USB device MS mode
#define USE_DEVICE_SN_UNIQUE       DISABLE            // ignore if USB_DEVICE_SN_USE = DISABLE

#define EP_MOUSE_IN           1  
#define EP_MS_IN              2
#define EP_MS_OUT             3
#define EP_HID_IN             4
#define EP_HID_OUT            5

#define Usb_unicode(a)         ((U16)(a))

#define USB_REMOTE_WAKEUP_FEATURE   DISABLE

   // write here the action to associate to each USB event
   // be carefull not to waste time in order not disturbing the functions
#define Usb_sof_action()         sof_action();
#define Usb_wake_up_action()
#define Usb_resume_action()
#define Usb_suspend_action()
#define Usb_reset_action()
#define Usb_vbus_on_action()
#define Usb_vbus_off_action()
#define Usb_set_configuration_action()

extern void sof_action(void);

   // write here the action to associate to each SCSI commands
   // be carefull not to waste time in order not disturbing the functions
#define Scsi_start_read_action()    Led2_on()
#define Scsi_stop_read_action()     Led2_off()
#define Scsi_start_write_action()   Led3_on()
#define Scsi_stop_write_action()    Led3_off()


#endif // _CONF_USB_H_

---