mirror of
https://github.com/apache/nuttx.git
synced 2026-06-06 16:50:55 +08:00
Merged in paimonen/nuttx/pullreq_DFU_interface (pull request #754)
This commit is contained in:
Gregory Nutt
@@ -0,0 +1,93 @@
|
||||
/****************************************************************************
|
||||
* include/nuttx/usb/dfu.h
|
||||
*
|
||||
* Copyright (C) 2011-2018 Gregory Nutt. All rights reserved.
|
||||
* Authors: Petteri Aimonen <jpa@git.mail.kapsi.fi>
|
||||
*
|
||||
* 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_DFU_H
|
||||
#define __INCLUDE_NUTTX_USB_DFU_H
|
||||
|
||||
/************************************************************************************
|
||||
* Included Files
|
||||
************************************************************************************/
|
||||
|
||||
#include <nuttx/config.h>
|
||||
#include <nuttx/usb/usbdev.h>
|
||||
|
||||
/************************************************************************************
|
||||
* Public Functions
|
||||
************************************************************************************/
|
||||
|
||||
#undef EXTERN
|
||||
#if defined(__cplusplus)
|
||||
# define EXTERN extern "C"
|
||||
extern "C"
|
||||
{
|
||||
#else
|
||||
# define EXTERN extern
|
||||
#endif
|
||||
|
||||
/****************************************************************************
|
||||
* Name: usbdev_dfu_get_composite_devdesc
|
||||
*
|
||||
* Description:
|
||||
* Helper function to fill in some constants into the composite
|
||||
* configuration struct.
|
||||
*
|
||||
* Input Parameters:
|
||||
* dev - Pointer to the configuration struct we should fill
|
||||
*
|
||||
* Returned Value:
|
||||
* None
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
void usbdev_dfu_get_composite_devdesc(struct composite_devdesc_s *dev);
|
||||
|
||||
/****************************************************************************
|
||||
* Name: usbdev_dfu_activate_bootloader
|
||||
*
|
||||
* Description:
|
||||
* Reboots into DFU bootloader mode. The USB DFU application side driver
|
||||
* will call this when it receives DFU_DETACH request. The board-specific
|
||||
* code must provide implementation for this function.
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
void usbdev_dfu_activate_bootloader();
|
||||
|
||||
#undef EXTERN
|
||||
#if defined(__cplusplus)
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* __INCLUDE_NUTTX_USB_DFU_H */
|
||||
@@ -259,6 +259,11 @@
|
||||
|
||||
#define USB_MAX_DEVICES (127)
|
||||
|
||||
/* Microsoft OS Descriptor specific values */
|
||||
#define USB_REQ_GETMSFTOSDESCRIPTOR (0xEE)
|
||||
#define MSFTOSDESC_INDEX_FUNCTION 4
|
||||
#define MSFTOSDESC_INDEX_EXTPROP 5
|
||||
|
||||
/************************************************************************************
|
||||
* Public Types
|
||||
************************************************************************************/
|
||||
@@ -417,6 +422,61 @@ struct usb_iaddesc_s
|
||||
};
|
||||
#define USB_SIZEOF_IADDESC 8
|
||||
|
||||
/* Microsoft OS function descriptor.
|
||||
* This can be used to request a specific driver (such as WINUSB) to be loaded
|
||||
* on Windows. Unlike other descriptors, it is requested by a special request
|
||||
* USB_REQ_GETMSFTOSDESCRIPTOR.
|
||||
* More details: https://msdn.microsoft.com/en-us/windows/hardware/gg463179
|
||||
* And excellent explanation: https://github.com/pbatard/libwdi/wiki/WCID-Devices
|
||||
*
|
||||
* The device will have exactly one "Extended Compat ID Feature Descriptor",
|
||||
* which may contain multiple "Function Descriptors" associated with different
|
||||
* interfaces.
|
||||
*/
|
||||
|
||||
struct usb_msft_os_function_desc_s
|
||||
{
|
||||
uint8_t firstif; /* Index of first associated interface */
|
||||
uint8_t nifs; /* Number of associated interfaces */
|
||||
uint8_t compatible_id[8]; /* COMPATIBLE_ID of the driver to load */
|
||||
uint8_t sub_id[8]; /* SUB_COMPATIBLE_ID of the driver */
|
||||
uint8_t reserved[6];
|
||||
};
|
||||
|
||||
struct usb_msft_os_feature_desc_s
|
||||
{
|
||||
uint8_t len[4]; /* Descriptor length */
|
||||
uint8_t version[2]; /* Descriptor syntax version, 0x0100 */
|
||||
uint8_t index[2]; /* Set to 4 for "extended compat ID descriptors" */
|
||||
uint8_t count; /* Number of function sections */
|
||||
uint8_t reserved[7];
|
||||
struct usb_msft_os_function_desc_s function[1];
|
||||
};
|
||||
|
||||
/* Microsoft OS extended property descriptor.
|
||||
* This can be used to set specific registry values, such as interface GUID for
|
||||
* a device. It is requested per-interface by special request USB_REQ_GETMSFTOSDESCRIPTOR.
|
||||
*
|
||||
* The interface will have one extended properties descriptor, which may contain
|
||||
* multiple properties inside it.
|
||||
*/
|
||||
struct usb_msft_os_extprop_hdr_s
|
||||
{
|
||||
uint8_t len[4]; /* Descriptor length */
|
||||
uint8_t version[2]; /* Descriptor syntax version, 0x0100 */
|
||||
uint8_t index[2]; /* Set to 5 for "extended property descriptors" */
|
||||
uint8_t count[2]; /* Number of property sections */
|
||||
|
||||
/* The properties are appended after the header and follow this format:
|
||||
* uint8_t prop_len[4];
|
||||
* uint8_t data_type[4];
|
||||
* uint8_t name_len[2];
|
||||
* uint8_t name[name_len];
|
||||
* uint8_t data_len[4];
|
||||
* uint8_t data[data_len];
|
||||
*/
|
||||
};
|
||||
|
||||
/************************************************************************************
|
||||
* Public Data
|
||||
************************************************************************************/
|
||||
|
||||
@@ -234,6 +234,11 @@ struct composite_devdesc_s
|
||||
int cfgdescsize; /* The size of the config descriptor */
|
||||
int minor;
|
||||
|
||||
#ifdef CONFIG_COMPOSITE_MSFT_OS_DESCRIPTORS
|
||||
uint8_t msft_compatible_id[8];
|
||||
uint8_t msft_sub_id[8];
|
||||
#endif
|
||||
|
||||
struct usbdev_devinfo_s devinfo;
|
||||
};
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user