conf_usb.h

Go to the documentation of this file.
00001 /*This file is prepared for Doxygen automatic documentation generation.*/
00013 
00014 /* Copyright (c) 2009 Atmel Corporation. All rights reserved.
00015  *
00016  * Redistribution and use in source and binary forms, with or without
00017  * modification, are permitted provided that the following conditions are met:
00018  *
00019  * 1. Redistributions of source code must retain the above copyright notice,
00020  * this list of conditions and the following disclaimer.
00021  *
00022  * 2. Redistributions in binary form must reproduce the above copyright notice,
00023  * this list of conditions and the following disclaimer in the documentation
00024  * and/or other materials provided with the distribution.
00025  *
00026  * 3. The name of Atmel may not be used to endorse or promote products derived
00027  * from this software without specific prior written permission.
00028  *
00029  * 4. This software may only be redistributed and used in connection with an Atmel
00030  * AVR product.
00031  *
00032  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
00033  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00034  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE EXPRESSLY AND
00035  * SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,
00036  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00037  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00038  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00039  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00040  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00041  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00042  */
00043 #ifndef _CONF_USB_H_
00044 #define _CONF_USB_H_
00045 
00046 
00047 #include "modules/usb/usb_commun.h"
00048 #include "modules/usb/usb_commun_hub.h"
00049 #include "modules/usb/usb_commun_ms.h"
00050 
00054 
00055 
00056    // _________________ USB MODE CONFIGURATION ____________________________
00057    //
00062 
00066       #define USB_HOST_FEATURE            ENABLED
00067 
00071       #define USB_DEVICE_FEATURE          ENABLED
00072 
00074 
00075    // _________________ USB REGULATOR CONFIGURATION _______________________
00076    //
00079 
00084 #ifndef USE_USB_PADS_REGULATOR
00085    #define USE_USB_PADS_REGULATOR   ENABLE      // Possible values ENABLE or DISABLE
00086 #endif
00088 
00089    // _________________ HOST MODE CONFIGURATION ____________________________
00090    //
00094 
00103    #define VID_PID_TABLE            {VID_ATMEL, 2, PID_MegaHIDMouse, 0x2014 \
00104                                     ,0x0123, 3, 0x2000, 0x2100, 0x1258}
00105 
00116    #define CLASS_SUBCLASS_PROTOCOL     {\
00117                                        0x00, 0x00, 0x00,\
00118                                        HUB_CLASS, 0x00, 0x00,\
00119                                        MS_CLASS, MS_SUB_CLASS2, MS_PROTOCOL,\
00120                                        MS_CLASS, MS_SUB_CLASS5, MS_PROTOCOL,\
00121                                        MS_CLASS, MS_SUB_CLASS6, MS_PROTOCOL,\
00122                                        }
00123 
00125    #define SIZEOF_DATA_STAGE        250
00126 
00128    #define DEVICE_BASE_ADDRESS      0x05
00129 
00131    #define MAX_EP_PER_INTERFACE     3
00132 
00134    #define MAX_INTERFACE_FOR_DEVICE 3
00135 
00137    #define MAX_DEVICE_IN_USB_TREE   4
00138 
00139 #define SAVE_INTERRUPT_PIPE_FOR_DMS_INTERFACE   ENABLE
00140 
00142 #if (MAX_DEVICE_IN_USB_TREE>1)
00143    #define USB_HUB_SUPPORT          ENABLE
00144    #define USB_MAX_HUB_NUMBER       4
00145    #define HUB_MAX_NB_PORT          4
00146 #else
00147    #define USB_HUB_SUPPORT          DISABLE
00148 #endif
00149 
00153    #define HOST_STRICT_VID_PID_TABLE      DISABLE
00154 
00156    #define HOST_AUTO_CFG_ENDPOINT         ENABLE
00157 
00159    #define HOST_CONTINUOUS_SOF_INTERRUPT  DISABLE
00160 
00162    #define HOST_ERROR_RESTART             ENABLE
00163 
00165    #define USB_HOST_PIPE_INTERRUPT_TRANSFER  ENABLE
00166 
00168    #define ID_PIN_CHANGE_GENERATE_RESET   DISABLE
00169 
00171    #define TIMEOUT_DELAY_ENABLE           ENABLE
00172 
00174    #define TIMEOUT_DELAY               10
00175 
00177    #define NAK_TIMEOUT_ENABLE          DISABLE
00178 
00180    #define NAK_SEND_TIMEOUT            0x0FFF
00181 
00183    #define NAK_RECEIVE_TIMEOUT         0x0FFF
00184 
00186    #define SOFTWARE_VBUS_CTRL          ENABLE
00187 
00188    #if (HOST_AUTO_CFG_ENDPOINT==FALSE)
00190       #define        User_configure_endpoint()
00191    #endif
00192 
00196    // write here the action to associate to each USB host event
00197    // be carefull not to waste time in order not disturbing the functions
00198    #define Usb_id_transition_action()
00199    #define Host_device_disconnection_action()
00200    #define Host_device_connection_action()
00201    #define Host_sof_action()                          host_sof_action()
00202    #define Host_suspend_action()
00203    #define Host_hwup_action()
00204    #define Host_device_not_supported_action()
00205    #define Host_device_class_not_supported_action()
00206    #define Host_device_supported_action()
00207    #define Host_device_error_action()
00209 
00210 extern void set_power_down_mode(void);
00211 extern void host_sof_action(void);
00213 
00214 
00215 // _________________ DEVICE MODE CONFIGURATION __________________________
00216 
00220 
00221 #define USB_DEVICE_SN_USE          ENABLE             // Must be enable to see all disks under Windows in USB device MS mode
00222 #define USE_DEVICE_SN_UNIQUE       DISABLE            // ignore if USB_DEVICE_SN_USE = DISABLE
00223 
00224 #define EP_MS_IN              1
00225 #define EP_MS_OUT             2
00226 
00227 #define Usb_unicode(a)         ((U16)(a))
00228 
00229 #define USB_REMOTE_WAKEUP_FEATURE   DISABLE
00230 
00234    // write here the action to associate to each USB event
00235    // be carefull not to waste time in order not disturbing the functions
00236 #define Usb_sof_action()
00237 #define Usb_wake_up_action()
00238 #define Usb_resume_action()
00239 #define Usb_suspend_action()
00240 #define Usb_reset_action()
00241 #define Usb_vbus_on_action()
00242 #define Usb_vbus_off_action()
00243 #define Usb_set_configuration_action()
00245 
00246 extern void sof_action(void);
00248 
00252    // write here the action to associate to each SCSI commands
00253    // be carefull not to waste time in order not disturbing the functions
00254 #define Scsi_start_read_action()    Led2_on()
00255 #define Scsi_stop_read_action()     Led2_off()
00256 #define Scsi_start_write_action()   Led3_on()
00257 #define Scsi_stop_write_action()    Led3_off()
00259 
00261 
00262 #endif // _CONF_USB_H_

Generated on Wed Sep 23 09:17:02 2009 for ATMEL by  doxygen 1.5.3