OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/subsys/usb/class/usb_dfu.c

717 lines
18 KiB
C
Raw Blame History

/*******************************************************************************
*
* Copyright(c) 2015,2016 Intel Corporation.
* Copyright(c) 2017 PHYTEC Messtechnik GmbH
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Intel Corporation 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.
*
******************************************************************************/
/**
* @brief DFU class driver
*
* USB DFU device class driver
*
*/
#include <init.h>
#include <kernel.h>
#include <stdio.h>
#include <errno.h>
#include <flash.h>
#include <dfu/mcuboot.h>
#include <dfu/flash_img.h>
#include <misc/byteorder.h>
#include <usb/usb_device.h>
#include <usb/usb_common.h>
#include <usb/class/usb_dfu.h>
#include <usb_descriptor.h>
#define LOG_LEVEL CONFIG_USB_DEVICE_LOG_LEVEL
#include <logging/log.h>
LOG_MODULE_REGISTER(usb_dfu);
#define NUMOF_ALTERNATE_SETTINGS 2
#ifdef CONFIG_USB_COMPOSITE_DEVICE
#define USB_DFU_MAX_XFER_SIZE CONFIG_USB_COMPOSITE_BUFFER_SIZE
#else
#define USB_DFU_MAX_XFER_SIZE CONFIG_USB_DFU_MAX_XFER_SIZE
#endif
struct usb_dfu_config {
struct usb_if_descriptor if0;
struct dfu_runtime_descriptor dfu_descr;
} __packed;
USBD_CLASS_DESCR_DEFINE(primary) struct usb_dfu_config dfu_cfg = {
/* Interface descriptor */
.if0 = {
.bLength = sizeof(struct usb_if_descriptor),
.bDescriptorType = USB_INTERFACE_DESC,
.bInterfaceNumber = 0,
.bAlternateSetting = 0,
.bNumEndpoints = 0,
.bInterfaceClass = DFU_DEVICE_CLASS,
.bInterfaceSubClass = DFU_SUBCLASS,
.bInterfaceProtocol = DFU_RT_PROTOCOL,
.iInterface = 0,
},
.dfu_descr = {
.bLength = sizeof(struct dfu_runtime_descriptor),
.bDescriptorType = DFU_FUNC_DESC,
.bmAttributes = DFU_ATTR_CAN_DNLOAD |
DFU_ATTR_CAN_UPLOAD |
DFU_ATTR_MANIFESTATION_TOLERANT,
.wDetachTimeOut =
sys_cpu_to_le16(CONFIG_USB_DFU_DETACH_TIMEOUT),
.wTransferSize =
sys_cpu_to_le16(CONFIG_USB_DFU_MAX_XFER_SIZE),
.bcdDFUVersion =
sys_cpu_to_le16(DFU_VERSION),
},
};
/* dfu mode device descriptor */
struct dev_dfu_mode_descriptor {
struct usb_device_descriptor device_descriptor;
struct usb_cfg_descriptor cfg_descr;
struct usb_sec_dfu_config {
struct usb_if_descriptor if0;
struct usb_if_descriptor if1;
struct dfu_runtime_descriptor dfu_descr;
} __packed sec_dfu_cfg;
} __packed;
USBD_DEVICE_DESCR_DEFINE(secondary)
struct dev_dfu_mode_descriptor dfu_mode_desc = {
/* Device descriptor */
.device_descriptor = {
.bLength = sizeof(struct usb_device_descriptor),
.bDescriptorType = USB_DEVICE_DESC,
.bcdUSB = sys_cpu_to_le16(USB_2_0),
.bDeviceClass = 0,
.bDeviceSubClass = 0,
.bDeviceProtocol = 0,
.bMaxPacketSize0 = MAX_PACKET_SIZE0,
.idVendor = sys_cpu_to_le16((u16_t)CONFIG_USB_DEVICE_VID),
.idProduct = sys_cpu_to_le16((u16_t)CONFIG_USB_DEVICE_PID),
.bcdDevice = sys_cpu_to_le16(BCDDEVICE_RELNUM),
.iManufacturer = 1,
.iProduct = 2,
.iSerialNumber = 3,
.bNumConfigurations = 1,
},
/* Configuration descriptor */
.cfg_descr = {
.bLength = sizeof(struct usb_cfg_descriptor),
.bDescriptorType = USB_CONFIGURATION_DESC,
.wTotalLength = 0,
.bNumInterfaces = 1,
.bConfigurationValue = 1,
.iConfiguration = 0,
.bmAttributes = USB_CONFIGURATION_ATTRIBUTES,
.bMaxPower = MAX_LOW_POWER,
},
.sec_dfu_cfg = {
/* Interface descriptor */
.if0 = {
.bLength = sizeof(struct usb_if_descriptor),
.bDescriptorType = USB_INTERFACE_DESC,
.bInterfaceNumber = 0,
.bAlternateSetting = 0,
.bNumEndpoints = 0,
.bInterfaceClass = DFU_DEVICE_CLASS,
.bInterfaceSubClass = DFU_SUBCLASS,
.bInterfaceProtocol = DFU_MODE_PROTOCOL,
.iInterface = 4,
},
.if1 = {
.bLength = sizeof(struct usb_if_descriptor),
.bDescriptorType = USB_INTERFACE_DESC,
.bInterfaceNumber = 0,
.bAlternateSetting = 1,
.bNumEndpoints = 0,
.bInterfaceClass = DFU_DEVICE_CLASS,
.bInterfaceSubClass = DFU_SUBCLASS,
.bInterfaceProtocol = DFU_MODE_PROTOCOL,
.iInterface = 5,
},
.dfu_descr = {
.bLength = sizeof(struct dfu_runtime_descriptor),
.bDescriptorType = DFU_FUNC_DESC,
.bmAttributes = DFU_ATTR_CAN_DNLOAD |
DFU_ATTR_CAN_UPLOAD |
DFU_ATTR_MANIFESTATION_TOLERANT,
.wDetachTimeOut =
sys_cpu_to_le16(CONFIG_USB_DFU_DETACH_TIMEOUT),
.wTransferSize =
sys_cpu_to_le16(USB_DFU_MAX_XFER_SIZE),
.bcdDFUVersion =
sys_cpu_to_le16(DFU_VERSION),
},
},
};
struct usb_string_desription {
struct usb_string_descriptor lang_descr;
struct usb_mfr_descriptor {
u8_t bLength;
u8_t bDescriptorType;
u8_t bString[USB_BSTRING_LENGTH(
CONFIG_USB_DEVICE_MANUFACTURER)];
} __packed utf16le_mfr;
struct usb_product_descriptor {
u8_t bLength;
u8_t bDescriptorType;
u8_t bString[USB_BSTRING_LENGTH(CONFIG_USB_DEVICE_PRODUCT)];
} __packed utf16le_product;
struct usb_sn_descriptor {
u8_t bLength;
u8_t bDescriptorType;
u8_t bString[USB_BSTRING_LENGTH(CONFIG_USB_DEVICE_SN)];
} __packed utf16le_sn;
struct image_0_descriptor {
u8_t bLength;
u8_t bDescriptorType;
u8_t bString[USB_BSTRING_LENGTH(FLASH_AREA_IMAGE_0_LABEL)];
} __packed utf16le_image0;
struct image_1_descriptor {
u8_t bLength;
u8_t bDescriptorType;
u8_t bString[USB_BSTRING_LENGTH(FLASH_AREA_IMAGE_1_LABEL)];
} __packed utf16le_image1;
} __packed;
USBD_STRING_DESCR_DEFINE(secondary)
struct usb_string_desription string_descr = {
.lang_descr = {
.bLength = sizeof(struct usb_string_descriptor),
.bDescriptorType = USB_STRING_DESC,
.bString = sys_cpu_to_le16(0x0409),
},
/* Manufacturer String Descriptor */
.utf16le_mfr = {
.bLength = USB_STRING_DESCRIPTOR_LENGTH(
CONFIG_USB_DEVICE_MANUFACTURER),
.bDescriptorType = USB_STRING_DESC,
.bString = CONFIG_USB_DEVICE_MANUFACTURER,
},
/* Product String Descriptor */
.utf16le_product = {
.bLength = USB_STRING_DESCRIPTOR_LENGTH(
CONFIG_USB_DEVICE_PRODUCT),
.bDescriptorType = USB_STRING_DESC,
.bString = CONFIG_USB_DEVICE_PRODUCT,
},
/* Serial Number String Descriptor */
.utf16le_sn = {
.bLength = USB_STRING_DESCRIPTOR_LENGTH(CONFIG_USB_DEVICE_SN),
.bDescriptorType = USB_STRING_DESC,
.bString = CONFIG_USB_DEVICE_SN,
},
/* Image 0 String Descriptor */
.utf16le_image0 = {
.bLength = USB_STRING_DESCRIPTOR_LENGTH(
FLASH_AREA_IMAGE_0_LABEL),
.bDescriptorType = USB_STRING_DESC,
.bString = FLASH_AREA_IMAGE_0_LABEL,
},
/* Image 1 String Descriptor */
.utf16le_image1 = {
.bLength = USB_STRING_DESCRIPTOR_LENGTH(
FLASH_AREA_IMAGE_1_LABEL),
.bDescriptorType = USB_STRING_DESC,
.bString = FLASH_AREA_IMAGE_1_LABEL,
},
};
/* This element marks the end of the entire descriptor. */
USBD_TERM_DESCR_DEFINE(secondary) struct usb_desc_header term_descr = {
.bLength = 0,
.bDescriptorType = 0,
};
static struct usb_cfg_data dfu_config;
/* Device data structure */
struct dfu_data_t {
/* Flash device to read/write data from/to */
struct device *flash_dev;
/* Flash layout data (image-0, image-1, image-scratch) */
u32_t flash_addr;
u32_t flash_upload_size;
/* Number of bytes sent during upload */
u32_t bytes_sent;
u32_t alt_setting; /* DFU alternate setting */
#ifdef CONFIG_USB_COMPOSITE_DEVICE
u8_t *buffer;
#else
u8_t buffer[USB_DFU_MAX_XFER_SIZE]; /* DFU data buffer */
#endif
struct flash_img_context ctx;
enum dfu_state state; /* State of the DFU device */
enum dfu_status status; /* Status of the DFU device */
u16_t block_nr; /* DFU block number */
};
static struct dfu_data_t dfu_data = {
.state = appIDLE,
.status = statusOK,
.flash_addr = CONFIG_FLASH_BASE_ADDRESS + FLASH_AREA_IMAGE_1_OFFSET,
.flash_upload_size = FLASH_AREA_IMAGE_1_SIZE,
.alt_setting = 0,
};
/**
* @brief Helper function to check if in DFU app state.
*
* @return true if app state, false otherwise.
*/
static bool dfu_check_app_state(void)
{
if (dfu_data.state == appIDLE ||
dfu_data.state == appDETACH) {
dfu_data.state = appIDLE;
return true;
}
return false;
}
/**
* @brief Helper function to reset DFU internal counters.
*/
static void dfu_reset_counters(void)
{
dfu_data.bytes_sent = 0U;
dfu_data.block_nr = 0U;
flash_img_init(&dfu_data.ctx, dfu_data.flash_dev);
}
static void dfu_flash_write(u8_t *data, size_t len)
{
bool flush = false;
if (!len) {
/* Download completed */
flush = true;
}
if (flash_img_buffered_write(&dfu_data.ctx, data, len, flush)) {
LOG_ERR("flash write error");
dfu_data.state = dfuERROR;
dfu_data.status = errWRITE;
} else if (!len) {
LOG_DBG("flash write done");
dfu_data.state = dfuMANIFEST_SYNC;
dfu_reset_counters();
if (boot_request_upgrade(false)) {
dfu_data.state = dfuERROR;
dfu_data.status = errWRITE;
}
} else {
dfu_data.state = dfuDNLOAD_IDLE;
}
LOG_DBG("bytes written 0x%x", flash_img_bytes_written(&dfu_data.ctx));
}
/**
* @brief Handler called for DFU Class requests not handled by the USB stack.
*
* @param pSetup Information about the request to execute.
* @param len Size of the buffer.
* @param data Buffer containing the request result.
*
* @return 0 on success, negative errno code on fail.
*/
static int dfu_class_handle_req(struct usb_setup_packet *pSetup,
s32_t *data_len, u8_t **data)
{
int ret;
u32_t len, bytes_left;
switch (pSetup->bRequest) {
case DFU_GETSTATUS:
LOG_DBG("DFU_GETSTATUS: status %d, state %d",
dfu_data.status, dfu_data.state);
if (dfu_data.state == dfuMANIFEST_SYNC) {
dfu_data.state = dfuIDLE;
}
(*data)[0] = dfu_data.status;
(*data)[1] = 0U;
(*data)[2] = 1U;
(*data)[3] = 0U;
(*data)[4] = dfu_data.state;
(*data)[5] = 0U;
*data_len = 6;
break;
case DFU_GETSTATE:
LOG_DBG("DFU_GETSTATE");
(*data)[0] = dfu_data.state;
*data_len = 1;
break;
case DFU_ABORT:
LOG_DBG("DFU_ABORT");
if (dfu_check_app_state()) {
return -EINVAL;
}
dfu_reset_counters();
dfu_data.state = dfuIDLE;
dfu_data.status = statusOK;
break;
case DFU_CLRSTATUS:
LOG_DBG("DFU_CLRSTATUS");
if (dfu_check_app_state()) {
return -EINVAL;
}
dfu_data.state = dfuIDLE;
dfu_data.status = statusOK;
break;
case DFU_DNLOAD:
LOG_DBG("DFU_DNLOAD block %d, len %d, state %d",
pSetup->wValue, pSetup->wLength, dfu_data.state);
if (dfu_check_app_state()) {
return -EINVAL;
}
switch (dfu_data.state) {
case dfuIDLE:
LOG_DBG("DFU_DNLOAD start");
dfu_reset_counters();
if (dfu_data.flash_addr != CONFIG_FLASH_BASE_ADDRESS
+ FLASH_AREA_IMAGE_1_OFFSET) {
dfu_data.status = errWRITE;
dfu_data.state = dfuERROR;
LOG_ERR("This area can not be overwritten");
break;
}
if (boot_erase_img_bank(FLASH_AREA_IMAGE_1_OFFSET)) {
dfu_data.state = dfuERROR;
dfu_data.status = errERASE;
break;
}
case dfuDNLOAD_IDLE:
dfu_flash_write(*data, pSetup->wLength);
break;
default:
LOG_ERR("DFU_DNLOAD wrong state %d", dfu_data.state);
dfu_data.state = dfuERROR;
dfu_data.status = errUNKNOWN;
dfu_reset_counters();
return -EINVAL;
}
break;
case DFU_UPLOAD:
LOG_DBG("DFU_UPLOAD block %d, len %d, state %d",
pSetup->wValue, pSetup->wLength, dfu_data.state);
if (dfu_check_app_state()) {
return -EINVAL;
}
switch (dfu_data.state) {
case dfuIDLE:
dfu_reset_counters();
LOG_DBG("DFU_UPLOAD start");
case dfuUPLOAD_IDLE:
if (!pSetup->wLength ||
dfu_data.block_nr != pSetup->wValue) {
LOG_DBG("DFU_UPLOAD block %d, expected %d, "
"len %d", pSetup->wValue,
dfu_data.block_nr, pSetup->wLength);
dfu_data.state = dfuERROR;
dfu_data.status = errUNKNOWN;
break;
}
/* Upload in progress */
bytes_left = dfu_data.flash_upload_size -
dfu_data.bytes_sent;
if (bytes_left < pSetup->wLength) {
len = bytes_left;
} else {
len = pSetup->wLength;
}
if (len) {
ret = flash_read(dfu_data.flash_dev,
dfu_data.flash_addr +
dfu_data.bytes_sent,
dfu_data.buffer, len);
if (ret) {
dfu_data.state = dfuERROR;
dfu_data.status = errFILE;
break;
}
}
*data_len = len;
*data = dfu_data.buffer;
dfu_data.bytes_sent += len;
dfu_data.block_nr++;
if (dfu_data.bytes_sent == dfu_data.flash_upload_size &&
len < pSetup->wLength) {
/* Upload completed when a
* short packet is received
*/
*data_len = 0;
dfu_data.state = dfuIDLE;
} else
dfu_data.state = dfuUPLOAD_IDLE;
break;
default:
LOG_ERR("DFU_UPLOAD wrong state %d", dfu_data.state);
dfu_data.state = dfuERROR;
dfu_data.status = errUNKNOWN;
dfu_reset_counters();
return -EINVAL;
}
break;
case DFU_DETACH:
LOG_DBG("DFU_DETACH timeout %d, state %d",
pSetup->wValue, dfu_data.state);
if (dfu_data.state != appIDLE) {
dfu_data.state = appIDLE;
return -EINVAL;
}
/* Move to appDETACH state */
dfu_data.state = appDETACH;
/* We should start a timer here but in order to
* keep things simple and do not increase the size
* we rely on the host to get us out of the appATTACHED
* state if needed.
*/
/* Set the DFU mode descriptors to be used after reset */
dfu_config.usb_device_description = (u8_t *) &dfu_mode_desc;
if (usb_set_config(&dfu_config) != 0) {
LOG_ERR("usb_set_config failed in DFU_DETACH");
return -EIO;
}
break;
default:
LOG_WRN("DFU UNKNOWN STATE: %d", pSetup->bRequest);
return -EINVAL;
}
return 0;
}
/**
* @brief Callback used to know the USB connection status
*
* @param status USB device status code.
*
* @return N/A.
*/
static void dfu_status_cb(enum usb_dc_status_code status, const u8_t *param)
{
ARG_UNUSED(param);
/* Check the USB status and do needed action if required */
switch (status) {
case USB_DC_ERROR:
LOG_DBG("USB device error");
break;
case USB_DC_RESET:
LOG_DBG("USB device reset detected, state %d", dfu_data.state);
if (dfu_data.state == appDETACH) {
dfu_data.state = dfuIDLE;
}
break;
case USB_DC_CONNECTED:
LOG_DBG("USB device connected");
break;
case USB_DC_CONFIGURED:
LOG_DBG("USB device configured");
break;
case USB_DC_DISCONNECTED:
LOG_DBG("USB device disconnected");
break;
case USB_DC_SUSPEND:
LOG_DBG("USB device supended");
break;
case USB_DC_RESUME:
LOG_DBG("USB device resumed");
break;
case USB_DC_SOF:
break;
case USB_DC_UNKNOWN:
default:
LOG_DBG("USB unknown state");
break;
}
}
/**
* @brief Custom handler for standard ('chapter 9') requests
* in order to catch the SET_INTERFACE request and
* extract the interface alternate setting
*
* @param pSetup Information about the request to execute.
* @param len Size of the buffer.
* @param data Buffer containing the request result.
*
* @return 0 if SET_INTERFACE request, -ENOTSUP otherwise.
*/
static int dfu_custom_handle_req(struct usb_setup_packet *pSetup,
s32_t *data_len, u8_t **data)
{
ARG_UNUSED(data);
if (REQTYPE_GET_RECIP(pSetup->bmRequestType) ==
REQTYPE_RECIP_INTERFACE) {
if (pSetup->bRequest == REQ_SET_INTERFACE) {
LOG_DBG("DFU alternate setting %d", pSetup->wValue);
switch (pSetup->wValue) {
case 0:
dfu_data.flash_addr =
CONFIG_FLASH_BASE_ADDRESS +
FLASH_AREA_IMAGE_0_OFFSET;
dfu_data.flash_upload_size =
FLASH_AREA_IMAGE_0_SIZE;
break;
case 1:
dfu_data.flash_addr =
CONFIG_FLASH_BASE_ADDRESS +
FLASH_AREA_IMAGE_1_OFFSET;
dfu_data.flash_upload_size =
FLASH_AREA_IMAGE_1_SIZE;
break;
default:
LOG_WRN("Invalid DFU alternate setting");
return -ENOTSUP;
}
dfu_data.alt_setting = pSetup->wValue;
*data_len = 0;
return 0;
}
}
/* Not handled by us */
return -ENOTSUP;
}
static void dfu_interface_config(u8_t bInterfaceNumber)
{
dfu_cfg.if0.bInterfaceNumber = bInterfaceNumber;
}
/* Configuration of the DFU Device send to the USB Driver */
USBD_CFG_DATA_DEFINE(dfu) struct usb_cfg_data dfu_config = {
.usb_device_description = NULL,
.interface_config = dfu_interface_config,
.interface_descriptor = &dfu_cfg.if0,
.cb_usb_status = dfu_status_cb,
.interface = {
.class_handler = dfu_class_handle_req,
.custom_handler = dfu_custom_handle_req,
.payload_data = NULL,
},
.num_endpoints = 0,
};
/*
* Dummy configuration, this is necessary to configure DFU mode descriptor
* which is an alternative (secondary) device descriptor.
*/
USBD_CFG_DATA_DEFINE(dfu_mode) struct usb_cfg_data dfu_mode_config = {
.usb_device_description = NULL,
.interface_config = NULL,
.interface_descriptor = &dfu_mode_desc.sec_dfu_cfg.if0,
.cb_usb_status = dfu_status_cb,
.interface = {
.class_handler = dfu_class_handle_req,
.custom_handler = dfu_custom_handle_req,
.payload_data = NULL,
},
.num_endpoints = 0,
};
static int usb_dfu_init(struct device *dev)
{
int ret;
ARG_UNUSED(dev);
dfu_data.flash_dev = device_get_binding(DT_FLASH_DEV_NAME);
if (!dfu_data.flash_dev) {
LOG_ERR("Flash device not found\n");
return -ENODEV;
}
#ifndef CONFIG_USB_COMPOSITE_DEVICE
dfu_config.interface.payload_data = dfu_data.buffer;
dfu_config.usb_device_description = usb_get_device_descriptor();
/* Initialize the USB driver with the right configuration */
ret = usb_set_config(&dfu_config);
if (ret < 0) {
LOG_ERR("Failed to config USB");
return ret;
}
/* Enable USB driver */
ret = usb_enable(&dfu_config);
if (ret < 0) {
LOG_ERR("Failed to enable USB");
return ret;
}
#endif
return 0;
}
SYS_INIT(usb_dfu_init, APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEVICE);
Reference in New Issue View Git Blame Copy Permalink