packages/devs/usb/sa11x0/v2_0/cdl/usbs_sa11x0.cdl

   1 # ====================================================================
   2 #
   3 #      usbs_sa11x0.cdl
   4 #
   5 #      SA11X0 USB support.
   6 #
   7 # ====================================================================
   8 #####ECOSGPLCOPYRIGHTBEGIN####
   9 ## -------------------------------------------
  10 ## This file is part of eCos, the Embedded Configurable Operating System.
  11 ## Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  12 ##
  13 ## eCos is free software; you can redistribute it and/or modify it under
  14 ## the terms of the GNU General Public License as published by the Free
  15 ## Software Foundation; either version 2 or (at your option) any later version.
  16 ##
  17 ## eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  18 ## WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 ## FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 ## for more details.
  21 ##
  22 ## You should have received a copy of the GNU General Public License along
  23 ## with eCos; if not, write to the Free Software Foundation, Inc.,
  24 ## 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  25 ##
  26 ## As a special exception, if other files instantiate templates or use macros
  27 ## or inline functions from this file, or you compile this file and link it
  28 ## with other works to produce a work based on this file, this file does not
  29 ## by itself cause the resulting work to be covered by the GNU General Public
  30 ## License. However the source code for this file must still be made available
  31 ## in accordance with section (3) of the GNU General Public License.
  32 ##
  33 ## This exception does not invalidate any other reasons why a work based on
  34 ## this file might be covered by the GNU General Public License.
  35 ##
  36 ## Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  37 ## at http://sources.redhat.com/ecos/ecos-license/
  38 ## -------------------------------------------
  39 #####ECOSGPLCOPYRIGHTEND####
  40 # ====================================================================
  41 ######DESCRIPTIONBEGIN####
  42 #
  43 # Author(s):      bartv
  44 # Original data:  bartv
  45 # Contributors:
  46 # Date:           2000-10-04
  47 #
  48 #####DESCRIPTIONEND####
  49 # ====================================================================
  50
  51 cdl_package CYGPKG_DEVS_USB_SA11X0 {
  52     display     "SA11X0 USB Device Driver"
  53     include_dir "cyg/io/usb"
  54     parent      CYGPKG_USB
  55     implements  CYGHWR_IO_USB_SLAVE
  56     doc         ref/devs-usb-sa11x0.html
  57
  58     # Make sure that we are running on the right hardware.
  59     requires CYGPKG_HAL_ARM
  60     requires CYGPKG_HAL_ARM_SA11X0
  61
  62
  63     description "
  64         The on-chip serial port 0 on the SA11X0 implements a USB
  65         device controller, facilitating the use of this processor
  66         in USB peripherals. This package provides a suitable eCos
  67         device driver."
  68
  69
  70     cdl_option CYGFUN_DEVS_USB_SA11X0_EP0 {
  71         display       "Support the control endpoint 0"
  72         default_value CYGINT_IO_USB_SLAVE_CLIENTS
  73         # And the USB support packages
  74         requires      CYGPKG_IO_USB CYGPKG_IO_USB_SLAVE
  75         compile       usbs_sa11x0.c
  76         compile       -library=libextras.a usbs_sa11x0_data.cxx
  77         description "
  78             Enable support for endpoint 0. If this support is disabled
  79             then the entire USB port is unusable."
  80     }
  81
  82     cdl_option CYGVAR_DEVS_USB_SA11X0_EP0_DEVTAB_ENTRY {
  83         display       "Provide a devtab entry for endpoint 0"
  84         default_value CYGGLO_IO_USB_SLAVE_PROVIDE_DEVTAB_ENTRIES
  85         requires      CYGPKG_IO
  86         description "
  87             If endpoint 0 will only be accessed via the low-level
  88             USB-specific calls then there is no need for an entry
  89             in the device table, saving some memory. If the
  90             application intends to access the endpoint by means
  91             of open and ioctl calls then a devtab entry is needed.
  92         "
  93     }
  94
  95     cdl_component CYGPKG_DEVS_USB_SA11X0_EP1 {
  96         display       "Support endpoint 1, used for host->slave communications"
  97         implements    CYGHWR_IO_USB_SLAVE_OUT_ENDPOINTS
  98         requires      CYGFUN_DEVS_USB_SA11X0_EP0
  99         default_value CYGFUN_DEVS_USB_SA11X0_EP0
 100         description "
 101             In the SA11X0 USB implementation endpoint 1 can only be
 102             used for host->slave communication. If the intended application
 103             only involves slave->host transfers then the support for
 104             endpoint 1 can be disabled. Note that this does not affect
 105             control messages which always go via endpoint 0."
 106
 107         cdl_option CYGNUM_DEVS_USB_SA11X0_EP1_DMA_CHANNEL {
 108             display       "Control DMA usage for endpoint 1"
 109             flavor        booldata
 110             legal_values  0 to 5
 111             default_value 4
 112             description "
 113                 In the SA11X0 USB implementation endpoint 1 only has
 114                 a 20-byte fifo. If the application only involves
 115                 small transfers then this may prove sufficient, but
 116                 for larger transfers the use of a DMA engine is
 117                 mandated. This configuration option allows the
 118                 use of DMA engine to be disabled or enabled, and the
 119                 specific DMA channel to be selected. The SA11X0
 120                 supports 6 DMA channels numbered 0 to 5. If DMA
 121                 is enabled for endpoint 1 then the selected channel
 122                 cannot be used by any other code."
 123         }
 124
 125         cdl_option CYGVAR_DEVS_USB_SA11X0_EP1_DEVTAB_ENTRY {
 126             display       "Provide a devtab entry for endpoint 1"
 127             default_value CYGGLO_IO_USB_SLAVE_PROVIDE_DEVTAB_ENTRIES
 128             requires      CYGPKG_IO
 129             description "
 130                 If endpoint 1 will only be accessed via the low-level
 131                 USB-specific calls then there is no need for an entry
 132                 in the device table, saving some memory. If the
 133                 application intends to access the endpoint by means
 134                 of open and read calls then a devtab entry is needed.
 135             "
 136         }
 137     }
 138
 139     cdl_component CYGPKG_DEVS_USB_SA11X0_EP2 {
 140         display       "Support endpoint 2, used for slave->host communications"
 141         implements CYGHWR_IO_USB_SLAVE_IN_ENDPOINTS
 142         requires      CYGFUN_DEVS_USB_SA11X0_EP0
 143         default_value CYGFUN_DEVS_USB_SA11X0_EP0
 144         description "
 145             In the SA11X0 USB implementation endpoint 2 can only be
 146             used for slave->host communication. If the intended application
 147             only involves host->slave transfers then the support for
 148             endpoint 2 can be disabled. Note that this does not affect
 149             control messages which always go via endpoint 0."
 150
 151         cdl_option CYGNUM_DEVS_USB_SA11X0_EP2_DMA_CHANNEL {
 152             display       "Control DMA usage for endpoint 2"
 153             flavor        booldata
 154             legal_values  0 to 5
 155             default_value 5
 156             description "
 157                 In the SA11X0 USB implementation endpoint 2 only has
 158                 a 16-byte fifo. If the application only involves
 159                 small transfers then this may prove sufficient, but
 160                 for larger transfers the use of a DMA engine is
 161                 mandated. This configuration option allows the
 162                 use of DMA engine to be disabled or enabled, and the
 163                 specific DMA channel to be selected. The SA11X0
 164                 supports 6 DMA channels numbered 0 to 5. If DMA
 165                 is enabled for endpoint 2 then the selected channel
 166                 cannot be used by any other code."
 167         }
 168
 169         cdl_option CYGVAR_DEVS_USB_SA11X0_EP2_DEVTAB_ENTRY {
 170             display       "Provide a devtab entry for endpoint 2"
 171             default_value CYGGLO_IO_USB_SLAVE_PROVIDE_DEVTAB_ENTRIES
 172             requires      CYGPKG_IO
 173             description "
 174                 If endpoint 2 will only be accessed via the low-level
 175                 USB-specific calls then there is no need for an entry
 176                 in the device table, saving some memory. If the
 177                 application intends to access the endpoint by means
 178                 of open and write calls then a devtab entry is needed.
 179             "
 180         }
 181     }
 182
 183     cdl_option CYGDAT_DEVS_USB_SA11X0_DEVTAB_BASENAME {
 184         display       "Base name for devtab entries"
 185         flavor        data
 186         active_if     { CYGVAR_DEVS_USB_SA11X0_EP0_DEVTAB_ENTRY ||
 187                         CYGVAR_DEVS_USB_SA11X0_EP1_DEVTAB_ENTRY ||
 188                         CYGVAR_DEVS_USB_SA11X0_EP2_DEVTAB_ENTRY
 189         }
 190         default_value { "\"/dev/usbs\"" }
 191         description "
 192             If the SA11X0 USB device driver package provides devtab
 193             entries for any of the endpoints then this option gives
 194             control over the names of these entries. By default the
 195             endpoints will be called \"/dev/usbs0c\", \"/dev/usbs1r\"
 196             and \"/dev/usbs2w\" (assuming all three endpoints are
 197             enabled. The common part \"/dev/usbs\" is determined
 198             by this configuration option. It may be necessary to
 199             change this if there are multiple USB slave-side
 200             devices on the target hardware to prevent a name clash.
 201         "
 202     }
 203 }