/**************************************************************************** * include/nuttx/usb/usbmsc.h * * Copyright (C) 2008-2010, 2012, 2017 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * 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 #include #include #include /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /* Information about the device needed in usbdev_devinfo_s */ #define USBMSC_CONFIGID (1) /* The only supported configuration ID */ #define USBMSC_NENDPOINTS (2) /* Number of endpoints in the interface */ #define USBMSC_EP_BULKIN_IDX (0) #define USBMSC_EP_BULKOUT_IDX (1) #define USBMSC_NCONFIGS (1) /* Number of configurations supported */ #define USBMSC_NINTERFACES (1) /* Number of interfaces in the configuration */ /**************************************************************************** * Public Types ****************************************************************************/ /**************************************************************************** * Public Data ****************************************************************************/ #undef EXTERN #if defined(__cplusplus) # define EXTERN extern "C" extern "C" { #else # define EXTERN extern #endif /**************************************************************************** * Public Functions ****************************************************************************/ /**************************************************************************** * 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(). * ****************************************************************************/ int usbmsc_configure(unsigned int nluns, FAR 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. * ****************************************************************************/ 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. * ****************************************************************************/ 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 * ****************************************************************************/ 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_USBDEV_COMPOSITE) && defined(CONFIG_USBMSC_COMPOSITE) struct usbdevclass_driver_s; int usbmsc_classobject(FAR void *handle, FAR struct usbdev_devinfo_s *devinfo, 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 * ****************************************************************************/ void usbmsc_uninitialize(FAR void *handle); /**************************************************************************** * Name: usbmsc_get_composite_devdesc * * Description: * Helper function to fill in some constants into the composite configuration * structure. * * Input Parameters: * dev - Pointer to the configuration struct we should fill * * Returned Value: * None * ****************************************************************************/ #if defined(CONFIG_USBDEV_COMPOSITE) && defined(CONFIG_USBMSC_COMPOSITE) struct composite_devdesc_s; void usbmsc_get_composite_devdesc(FAR struct composite_devdesc_s *dev); #endif #undef EXTERN #if defined(__cplusplus) } #endif #endif /* __INCLUDE_NUTTX_USB_USBMSC_H */