Browse Source
git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@4340 7fd9a85b-ad96-42d3-883c-3090e2eb8679sbg
patacongo
13 years ago
13 changed files with 702 additions and 190 deletions
@ -0,0 +1,186 @@
@@ -0,0 +1,186 @@
|
||||
/************************************************************************************
|
||||
* include/nuttx/usb/composite.h |
||||
* |
||||
* Copyright (C) 2008-2011 Gregory Nutt. All rights reserved. |
||||
* Author: Gregory Nutt <gnutt@nuttx.org> |
||||
* |
||||
* 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. Neither the name NuttX nor the names of its contributors may be |
||||
* used to endorse or promote products derived from this software |
||||
* without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
||||
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
||||
* COPYRIGHT OWNER OR CONTRIBUTORS 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 __NUTTX_USB_COMPOSITE_H |
||||
#define __NUTTX_USB_COMPOSITE_H |
||||
|
||||
/****************************************************************************
|
||||
* Included Files |
||||
****************************************************************************/ |
||||
|
||||
#include <nuttx/config.h> |
||||
|
||||
#ifdef CONFIG_USBDEV_COMPOSITE |
||||
|
||||
/****************************************************************************
|
||||
* Pre-processor Definitions |
||||
****************************************************************************/ |
||||
/* Configuration ************************************************************/ |
||||
/* CONFIG_USBDEV_COMPOSITE
|
||||
* Enables USB composite device support |
||||
* CONFIG_CDCACM_COMPOSITE |
||||
* Configure the CDC serial driver as part of a composite driver |
||||
* (only if CONFIG_USBDEV_COMPOSITE is also defined) |
||||
* CONFIG_COMPOSITE_COMPOSITE |
||||
* Configure the mass storage driver as part of a composite driver |
||||
* (only if CONFIG_USBDEV_COMPOSITE is also defined) |
||||
* CONFIG_COMPOSITE_EP0MAXPACKET |
||||
* Max packet size for endpoint 0 |
||||
* CONFIG_COMPOSITE_VENDORID and CONFIG_COMPOSITE_VENDORSTR |
||||
* The vendor ID code/string |
||||
* CONFIG_COMPOSITE_PRODUCTID and CONFIG_COMPOSITE_PRODUCTSTR |
||||
* The product ID code/string |
||||
* CONFIG_COMPOSITE_SERIALSTR |
||||
* Device serial number string |
||||
* CONFIG_COMPOSITE_CONFIGSTR |
||||
* Configuration string |
||||
* CONFIG_COMPOSITE_VERSIONNO |
||||
* Interface version number. |
||||
*/ |
||||
|
||||
/****************************************************************************
|
||||
* Public Types |
||||
****************************************************************************/ |
||||
|
||||
/****************************************************************************
|
||||
* Public Data |
||||
****************************************************************************/ |
||||
|
||||
#undef EXTERN |
||||
#if defined(__cplusplus) |
||||
#define EXTERN extern "C" |
||||
extern "C" { |
||||
#else |
||||
#define EXTERN extern |
||||
#endif |
||||
|
||||
/****************************************************************************
|
||||
* Public Functions |
||||
****************************************************************************/ |
||||
|
||||
/****************************************************************************
|
||||
* Name: composite_initialize |
||||
* |
||||
* Description: |
||||
* Register USB composite device as configured. This function will call |
||||
* board-specific implementations in order to obtain the class objects for |
||||
* each of the members of the composite (see board_mscclassobject(), |
||||
* board_cdcclassobjec(), ...)
|
||||
* |
||||
* Input Parameter: |
||||
* None |
||||
* |
||||
* Returned Value: |
||||
* A non-NULL "handle" is returned on success. This handle may be used |
||||
* later with composite_uninitialize() in order to removed the composite |
||||
* device. This handle is the (untyped) internal representation of the |
||||
* the class driver instance. |
||||
* |
||||
* NULL is returned on any failure. |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
EXTERN FAR void *composite_initialize(void); |
||||
|
||||
/****************************************************************************
|
||||
* Name: usbmsc_uninitialize |
||||
* |
||||
* Description: |
||||
* Un-initialize the USB composite driver. The handle is the USB composite |
||||
* class' device object as was returned by composite_initialize(). This |
||||
* function will call board-specific implementations in order to free the |
||||
* class objects for each of the members of the composite (see |
||||
* board_mscuninitialize(), board_cdcuninitialize(), ...)
|
||||
* |
||||
* Input Parameters: |
||||
* handle - The handle returned by a previous call to composite_initialize(). |
||||
* |
||||
* Returned Value: |
||||
* None |
||||
* |
||||
***************************************************************************/ |
||||
|
||||
EXTERN void usbmsc_uninitialize(FAR void *handle); |
||||
|
||||
/****************************************************************************
|
||||
* Name: composite_initialize |
||||
* |
||||
* Description: |
||||
* Register USB composite device as configured. This function will call |
||||
* board-specific implementations in order to obtain the class objects for |
||||
* each of the members of the composite (see board_mscclassobject(), |
||||
* board_cdcclassobjec(), ...)
|
||||
* |
||||
* Input Parameter: |
||||
* None |
||||
* |
||||
* Returned Value: |
||||
* A non-NULL "handle" is returned on success. This handle may be used |
||||
* later with composite_uninitialize() in order to removed the composite |
||||
* device. This handle is the (untyped) internal representation of the |
||||
* the class driver instance. |
||||
* |
||||
* NULL is returned on any failure. |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
EXTERN FAR void *composite_initialize(void); |
||||
|
||||
/****************************************************************************
|
||||
* Name: composite_ep0submit |
||||
* |
||||
* Description: |
||||
* Members of the composite cannot send on EP0 directly because EP0 is |
||||
* is "owned" by the composite device. Instead, when configured as members |
||||
* of a composite device, those classes should call this method so that |
||||
* the composite device can send on EP0 onbehalf of the class. |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
struct usbdevclass_driver_s; |
||||
struct usbdev_s; |
||||
struct usbdev_req_s; |
||||
|
||||
EXTERN int composite_ep0submit(FAR struct usbdevclass_driver_s *driver, |
||||
FAR struct usbdev_s *dev, |
||||
FAR struct usbdev_req_s *ctrlreq); |
||||
|
||||
#undef EXTERN |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif /* CONFIG_USBDEV_COMPOSITE */ |
||||
#endif /* __NUTTX_USB_COMPOSITE_H */ |
||||
@ -0,0 +1,91 @@
@@ -0,0 +1,91 @@
|
||||
/************************************************************************************
|
||||
* include/nuttx/usb/pl2303.h |
||||
* |
||||
* Copyright (C) 2008-2010, 2012 Gregory Nutt. All rights reserved. |
||||
* Author: Gregory Nutt <gnutt@nuttx.org> |
||||
* |
||||
* NOTE: This interface was inspired by the Linux gadget interface by |
||||
* David Brownell. That work was very helpful in determining a usable |
||||
* partitioning of functionality between standard class drivers and various |
||||
* implementations of USB controller drivers. This work, however, does |
||||
* not derive directly from that work and is licensed differently. |
||||
* |
||||
* 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. Neither the name NuttX nor the names of its contributors may be |
||||
* used to endorse or promote products derived from this software |
||||
* without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
||||
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
||||
* COPYRIGHT OWNER OR CONTRIBUTORS 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 _INCLUDE_NUTTX_USB_PL2303_H |
||||
#define _INCLUDE_NUTTX_USB_PL2303_H |
||||
|
||||
/************************************************************************************
|
||||
* Included Files |
||||
************************************************************************************/ |
||||
|
||||
#include <nuttx/config.h> |
||||
|
||||
/************************************************************************************
|
||||
* Pre-processor Definitions |
||||
************************************************************************************/ |
||||
|
||||
/************************************************************************************
|
||||
* Public Types |
||||
************************************************************************************/ |
||||
|
||||
/************************************************************************************
|
||||
* Public Data |
||||
************************************************************************************/ |
||||
|
||||
#undef EXTERN |
||||
#if defined(__cplusplus) |
||||
# define EXTERN extern "C" |
||||
extern "C" |
||||
{ |
||||
#else |
||||
# define EXTERN extern |
||||
#endif |
||||
|
||||
/************************************************************************************
|
||||
* Public Functions |
||||
************************************************************************************/ |
||||
|
||||
/************************************************************************************
|
||||
* Name: usbdev_serialinit |
||||
* |
||||
* Description: |
||||
* Register PL2303 USB serial port (and USB serial console if so configured). |
||||
* |
||||
************************************************************************************/ |
||||
|
||||
EXTERN int usbdev_serialinitialize(int minor); |
||||
|
||||
#undef EXTERN |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif /* _INCLUDE_NUTTX_USB_PL2303_H */ |
||||
@ -0,0 +1,257 @@
@@ -0,0 +1,257 @@
|
||||
/************************************************************************************
|
||||
* include/nuttx/usb/usbmsc.h |
||||
* |
||||
* Copyright (C) 2008-2010, 2012 Gregory Nutt. All rights reserved. |
||||
* Author: Gregory Nutt <gnutt@nuttx.org> |
||||
* |
||||
* NOTE: This interface was inspired by the Linux gadget interface by |
||||
* David Brownell. That work was very helpful in determining a usable |
||||
* partitioning of functionality between standard class drivers and various |
||||
* implementations of USB controller drivers. This work, however, does |
||||
* not derive directly from that work and is licensed differently. |
||||
* |
||||
* 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. Neither the name NuttX nor the names of its contributors may be |
||||
* used to endorse or promote products derived from this software |
||||
* without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
||||
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
||||
* COPYRIGHT OWNER OR CONTRIBUTORS 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 _INCLUDE_NUTTX_USB_USBMSC_H |
||||
#define _INCLUDE_NUTTX_USB_USBMSC_H |
||||
|
||||
/************************************************************************************
|
||||
* Included Files |
||||
************************************************************************************/ |
||||
|
||||
#include <nuttx/config.h> |
||||
|
||||
#include <sys/types.h> |
||||
#include <stdint.h> |
||||
#include <stdbool.h> |
||||
|
||||
/************************************************************************************
|
||||
* Pre-processor Definitions |
||||
************************************************************************************/ |
||||
|
||||
/************************************************************************************
|
||||
* Public Types |
||||
************************************************************************************/ |
||||
|
||||
/************************************************************************************
|
||||
* Public Data |
||||
************************************************************************************/ |
||||
|
||||
#undef EXTERN |
||||
#if defined(__cplusplus) |
||||
# define EXTERN extern "C" |
||||
extern "C" |
||||
{ |
||||
#else |
||||
# define EXTERN extern |
||||
#endif |
||||
|
||||
/************************************************************************************
|
||||
* Public Functions |
||||
************************************************************************************/ |
||||
|
||||
/************************************************************************************
|
||||
* Name: board_mscclassobject |
||||
* |
||||
* Description: |
||||
* If the mass storage class driver is part of composite device, then |
||||
* its instantiation and configuration is a multi-step, board-specific, |
||||
* process (See comments for usbmsc_configure below). In this case, |
||||
* board-specific logic must provide board_mscclassobject(). |
||||
* |
||||
* board_mscclassobject() is called from the composite driver. It must |
||||
* encapsulate the instantiation and configuration of the mass storage |
||||
* class and the return the mass storage device's class driver instance |
||||
* to the composite dirver. |
||||
* |
||||
* Input Parameters: |
||||
* classdev - The location to return the mass storage class' device |
||||
* instance. |
||||
* |
||||
* Returned Value: |
||||
* 0 on success; a negated errno on failure |
||||
* |
||||
************************************************************************************/ |
||||
|
||||
#if defined(CONFIG_USBMSC_COMPOSITE) && defined(CONFIG_USBMSC_COMPOSITE) |
||||
struct usbdevclass_driver_s; |
||||
EXTERN int board_mscclassobject(FAR struct usbdevclass_driver_s **classdev); |
||||
#endif |
||||
|
||||
/****************************************************************************
|
||||
* Name: board_mscuninitialize |
||||
* |
||||
* Description: |
||||
* Un-initialize the USB storage class driver. This is just an application- |
||||
* specific wrapper aboutn usbmsc_unitialize() that is called form the composite |
||||
* device logic. |
||||
* |
||||
* Input Parameters: |
||||
* classdev - The class driver instrance previously give to the composite |
||||
* driver by board_mscclassobject(). |
||||
* |
||||
* Returned Value: |
||||
* None |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
#if defined(CONFIG_USBMSC_COMPOSITE) && defined(CONFIG_USBMSC_COMPOSITE) |
||||
struct usbdevclass_driver_s; |
||||
EXTERN void board_mscuninitialize(FAR struct usbdevclass_driver_s *classdev); |
||||
#endif |
||||
|
||||
/************************************************************************************
|
||||
* Name: usbmsc_configure |
||||
* |
||||
* Description: |
||||
* One-time initialization of the USB storage driver. The initialization |
||||
* sequence is as follows: |
||||
* |
||||
* 1. Call usbmsc_configure to perform one-time initialization specifying |
||||
* the number of luns. |
||||
* 2. Call usbmsc_bindlun to configure each supported LUN |
||||
* 3. Call usbmsc_exportluns when all LUNs are configured |
||||
* |
||||
* Input Parameters: |
||||
* nluns - the number of LUNs that will be registered |
||||
* handle - Location to return a handle that is used in other API calls. |
||||
* |
||||
* Returned Value: |
||||
* 0 on success; a negated errno on failure. The returned handle value is |
||||
* an untyped equivalent to the usbmsc_classobject() or board_mscclassobject(). |
||||
* |
||||
************************************************************************************/ |
||||
|
||||
EXTERN int usbmsc_configure(unsigned int nluns, void **handle); |
||||
|
||||
/************************************************************************************
|
||||
* Name: usbmsc_bindlun |
||||
* |
||||
* Description: |
||||
* Bind the block driver specified by drvrpath to a USB storage LUN. |
||||
* |
||||
* Input Parameters: |
||||
* handle - The handle returned by a previous call to usbmsc_configure(). |
||||
* drvrpath - the full path to the block driver |
||||
* startsector - A sector offset into the block driver to the start of the |
||||
* partition on drvrpath (0 if no partitions) |
||||
* nsectors - The number of sectors in the partition (if 0, all sectors |
||||
* to the end of the media will be exported). |
||||
* lunno - the LUN to bind to |
||||
* |
||||
* Returned Value: |
||||
* 0 on success; a negated errno on failure. |
||||
* |
||||
************************************************************************************/ |
||||
|
||||
EXTERN int usbmsc_bindlun(FAR void *handle, FAR const char *drvrpath, |
||||
unsigned int lunno, off_t startsector, size_t nsectors, |
||||
bool readonly); |
||||
|
||||
/************************************************************************************
|
||||
* Name: usbmsc_unbindlun |
||||
* |
||||
* Description: |
||||
* Un-bind the block driver for the specified LUN |
||||
* |
||||
* Input Parameters: |
||||
* handle - The handle returned by a previous call to usbmsc_configure(). |
||||
* lun - the LUN to unbind from |
||||
* |
||||
* Returned Value: |
||||
* 0 on success; a negated errno on failure. |
||||
* |
||||
************************************************************************************/ |
||||
|
||||
EXTERN int usbmsc_unbindlun(FAR void *handle, unsigned int lunno); |
||||
|
||||
/************************************************************************************
|
||||
* Name: usbmsc_exportluns |
||||
* |
||||
* Description: |
||||
* After all of the LUNs have been bound, this function may be called in order to |
||||
* export those LUNs in the USB storage device. |
||||
* |
||||
* Input Parameters: |
||||
* handle - The handle returned by a previous call to usbmsc_configure(). |
||||
* |
||||
* Returned Value: |
||||
* 0 on success; a negated errno on failure |
||||
* |
||||
************************************************************************************/ |
||||
|
||||
EXTERN int usbmsc_exportluns(FAR void *handle); |
||||
|
||||
/************************************************************************************
|
||||
* Name: usbmsc_classobject |
||||
* |
||||
* Description: |
||||
* Register USB mass storage device and return the class object. |
||||
* |
||||
* Input Parameters: |
||||
* classdev - The location to return the CDC serial class' device |
||||
* instance. |
||||
* |
||||
* Returned Value: |
||||
* 0 on success; a negated errno on failure |
||||
|
||||
* |
||||
************************************************************************************/ |
||||
|
||||
#if defined(CONFIG_USBMSC_COMPOSITE) && defined(CONFIG_USBMSC_COMPOSITE) |
||||
struct usbdevclass_driver_s; |
||||
EXTERN int usbmsc_classobject(FAR void *handle, FAR struct usbdevclass_driver_s **classdev); |
||||
#endif |
||||
|
||||
/************************************************************************************
|
||||
* Name: usbmsc_uninitialize |
||||
* |
||||
* Description: |
||||
* Un-initialize the USB storage class driver. The handle is the USB MSC |
||||
* class' device object. This is the same value as returned by usbmsc_classobject |
||||
* (typed) or by usbmsc_configure (untyped). |
||||
* |
||||
* Input Parameters: |
||||
* handle - The handle returned by a previous call to usbmsc_configure() |
||||
* (or usbmsc_classobject()). |
||||
* |
||||
* Returned Value: |
||||
* None |
||||
* |
||||
***********************************************************************************/ |
||||
|
||||
EXTERN void usbmsc_uninitialize(FAR void *handle); |
||||
|
||||
#undef EXTERN |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif /* _INCLUDE_NUTTX_USB_USBMSC_H */ |
||||
Loading…
Reference in new issue