mirror of
https://github.com/azure-rtos/usbx.git
synced 2025-02-04 07:13:12 +08:00
5f758e08fe
35e477cd Fixed error checking issues on device printer class. 7bc1a9b5 USBX device video error checking support. fb766837 Moved build option check to runtime (device HID, storage). 3af71cf8 Add optional error checking to host HIDs e6d938ad generate usbx cmsis-pack 62c0c282 Add error checking to host serial classes (CDC ACM, GSER, PROLIFIC and SWAR) 89b8890b USBX device DFU error checking support. 4c3c3922 USBX device CCID error checking support. 1411aab4 Add error checks for device HID and RNDIS. 2f83bd01 Added host audio error checking. 18973298 USBX device CDC ACM error checking support.
281 lines
15 KiB
C
281 lines
15 KiB
C
/**************************************************************************/
|
|
/* */
|
|
/* Copyright (c) Microsoft Corporation. All rights reserved. */
|
|
/* */
|
|
/* This software is licensed under the Microsoft Software License */
|
|
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
|
|
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
|
|
/* and in the root directory of this software. */
|
|
/* */
|
|
/**************************************************************************/
|
|
|
|
/**************************************************************************/
|
|
/**************************************************************************/
|
|
/** */
|
|
/** USBX Component */
|
|
/** */
|
|
/** DFU Class */
|
|
/** */
|
|
/**************************************************************************/
|
|
/**************************************************************************/
|
|
|
|
/**************************************************************************/
|
|
/* */
|
|
/* COMPONENT DEFINITION RELEASE */
|
|
/* */
|
|
/* ux_device_class_dfu.h PORTABLE C */
|
|
/* 6.x */
|
|
/* AUTHOR */
|
|
/* */
|
|
/* Chaoqiong Xiao, Microsoft Corporation */
|
|
/* */
|
|
/* DESCRIPTION */
|
|
/* */
|
|
/* This file defines the equivalences for the USBX Device Class DFU */
|
|
/* ACM component. */
|
|
/* */
|
|
/* RELEASE HISTORY */
|
|
/* */
|
|
/* DATE NAME DESCRIPTION */
|
|
/* */
|
|
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
|
|
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
|
|
/* used UX prefix to refer to */
|
|
/* TX symbols instead of using */
|
|
/* them directly, */
|
|
/* resulting in version 6.1 */
|
|
/* 04-02-2021 Chaoqiong Xiao Modified comment(s), */
|
|
/* added DFU_UPLOAD support, */
|
|
/* refined dfu_read prototype, */
|
|
/* removed block count (it's */
|
|
/* from host request wValue), */
|
|
/* resulting in version 6.1.6 */
|
|
/* 08-02-2021 Chaoqiong Xiao Modified comment(s), */
|
|
/* added extern "C" keyword */
|
|
/* for compatibility with C++, */
|
|
/* resulting in version 6.1.8 */
|
|
/* 01-31-2022 Chaoqiong Xiao Modified comment(s), */
|
|
/* added standalone support, */
|
|
/* resulting in version 6.1.10 */
|
|
/* 07-29-2022 Chaoqiong Xiao Modified comment(s), */
|
|
/* added macros for req types, */
|
|
/* resulting in version 6.1.12 */
|
|
/* xx-xx-xxxx Yajun xia Modified comment(s), */
|
|
/* added error checks support, */
|
|
/* resulting in version 6.x */
|
|
/* */
|
|
/**************************************************************************/
|
|
|
|
#ifndef UX_DEVICE_CLASS_DFU_H
|
|
#define UX_DEVICE_CLASS_DFU_H
|
|
|
|
/* Determine if a C++ compiler is being used. If so, ensure that standard
|
|
C is used to process the API information. */
|
|
|
|
#ifdef __cplusplus
|
|
|
|
/* Yes, C++ compiler is present. Use standard C. */
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
/* Internal option: enable the basic USBX error checking. This define is typically used
|
|
while debugging application. */
|
|
#if defined(UX_ENABLE_ERROR_CHECKING) && !defined(UX_DEVICE_CLASS_DFU_ENABLE_ERROR_CHECKING)
|
|
#define UX_DEVICE_CLASS_DFU_ENABLE_ERROR_CHECKING
|
|
#endif
|
|
|
|
/* Define DFU class descriptor capabilities. */
|
|
#define UX_SLAVE_CLASS_DFU_CAPABILITY_WILL_DETACH 0x08
|
|
#define UX_SLAVE_CLASS_DFU_CAPABILITY_MANIFESTATION_TOLERANT 0x04
|
|
#define UX_SLAVE_CLASS_DFU_CAPABILITY_CAN_UPLOAD 0x02
|
|
#define UX_SLAVE_CLASS_DFU_CAPABILITY_CAN_DOWNLOAD 0x01
|
|
|
|
/* Define DFU Class USB Class constants. */
|
|
#define UX_SLAVE_CLASS_DFU_CLASS 0xFE
|
|
#define UX_SLAVE_CLASS_DFU_SUBCLASS 0x01
|
|
#define UX_SLAVE_CLASS_DFU_PROTOCOL_RUNTIME 0x01
|
|
#define UX_SLAVE_CLASS_DFU_PROTOCOL_DFU_MODE 0x02
|
|
|
|
/* Define DFU MODES signals. */
|
|
#define UX_DEVICE_CLASS_DFU_MODE_RUNTIME 1
|
|
#define UX_DEVICE_CLASS_DFU_MODE_DFU 2
|
|
|
|
|
|
/* Device DFU bmRequestType. */
|
|
#define UX_DEVICE_CLASS_DFU_REQTYPE_INTERFACE_SET (UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE) /* 00100001b, 0x21 */
|
|
#define UX_DEVICE_CLASS_DFU_REQTYPE_INTERFACE_GET (UX_REQUEST_IN | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE) /* 10100001b, 0xA1 */
|
|
|
|
|
|
/* Device DFU Requests */
|
|
#define UX_SLAVE_CLASS_DFU_COMMAND_DETACH 0
|
|
#define UX_SLAVE_CLASS_DFU_COMMAND_DOWNLOAD 1
|
|
#define UX_SLAVE_CLASS_DFU_COMMAND_UPLOAD 2
|
|
#define UX_SLAVE_CLASS_DFU_COMMAND_GET_STATUS 3
|
|
#define UX_SLAVE_CLASS_DFU_COMMAND_CLEAR_STATUS 4
|
|
#define UX_SLAVE_CLASS_DFU_COMMAND_GET_STATE 5
|
|
#define UX_SLAVE_CLASS_DFU_COMMAND_ABORT 6
|
|
|
|
/* Device DFU Status values */
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_OK 0x00
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_TARGET 0x01
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_FILE 0x02
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_WRITE 0x03
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_ERASE 0x04
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_CHECK_ERASED 0x05
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_PROG 0x06
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_VERIFY 0x07
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_ADDRESS 0x08
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_NOTDONE 0x09
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_FIRMWARE 0x0A
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_VENDOR 0x0B
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_USBR 0x0C
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_POR 0x0D
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_UNKNOWN 0x0E
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_ERROR_STALLEDPKT 0x0F
|
|
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_APP_IDLE 0
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_APP_DETACH 1
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_DFU_IDLE 2
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_DFU_DNLOAD_SYNC 3
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_DFU_DNBUSY 4
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_DFU_DNLOAD_IDLE 5
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_DFU_MANIFEST_SYNC 6
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_DFU_MANIFEST 7
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_DFU_MANIFEST_WAIT_RESET 8
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_DFU_UPLOAD_IDLE 9
|
|
#define UX_SLAVE_CLASS_DFU_STATUS_STATE_DFU_ERROR 10
|
|
|
|
/* Define DFU class GET_STATUS command response. */
|
|
#define UX_SLAVE_CLASS_DFU_GET_STATUS_STATUS 0
|
|
#define UX_SLAVE_CLASS_DFU_GET_STATUS_POLL_TIMEOUT 1
|
|
#define UX_SLAVE_CLASS_DFU_GET_STATUS_STATE 4
|
|
#define UX_SLAVE_CLASS_DFU_GET_STATUS_STRING 5
|
|
#define UX_SLAVE_CLASS_DFU_GET_STATUS_LENGTH 6
|
|
|
|
/* Status mode for DFU_GETSTATUS
|
|
0 - simple mode,
|
|
status is queried from application in dfuDNLOAD-SYNC and dfuMANIFEST-SYNC state,
|
|
no bwPollTimeout.
|
|
1 - status is queried from application once requested,
|
|
b0-3 : media status
|
|
b4-7 : bStatus
|
|
b8-31: bwPollTimeout
|
|
bwPollTimeout supported.
|
|
*/
|
|
#ifndef UX_DEVICE_CLASS_DFU_STATUS_MODE
|
|
#define UX_DEVICE_CLASS_DFU_STATUS_MODE (0)
|
|
#endif
|
|
|
|
/* Status mode 0 bwPollTimeout (width: 3 bytes, ~0xFFFFFF). */
|
|
#ifndef UX_DEVICE_CLASS_DFU_STATUS_POLLTIMEOUT
|
|
#define UX_DEVICE_CLASS_DFU_STATUS_POLLTIMEOUT (1)
|
|
#endif
|
|
|
|
|
|
/* Define DFU class GET_STATE command response. */
|
|
#define UX_SLAVE_CLASS_DFU_GET_STATE_STATE 0
|
|
#define UX_SLAVE_CLASS_DFU_GET_STATE_LENGTH 1
|
|
|
|
/* Define DFU application notification signals. */
|
|
#define UX_SLAVE_CLASS_DFU_NOTIFICATION_BEGIN_DOWNLOAD 0x1u
|
|
#define UX_SLAVE_CLASS_DFU_NOTIFICATION_END_DOWNLOAD 0x2u
|
|
#define UX_SLAVE_CLASS_DFU_NOTIFICATION_ABORT_DOWNLOAD 0x3u
|
|
#define UX_SLAVE_CLASS_DFU_NOTIFICATION_BEGIN_UPLOAD 0x5u
|
|
#define UX_SLAVE_CLASS_DFU_NOTIFICATION_END_UPLOAD 0x6u
|
|
#define UX_SLAVE_CLASS_DFU_NOTIFICATION_ABORT_UPLOAD 0x7u
|
|
|
|
/* Define DFU application notification signals. */
|
|
#define UX_SLAVE_CLASS_DFU_MEDIA_STATUS_OK 0
|
|
#define UX_SLAVE_CLASS_DFU_MEDIA_STATUS_BUSY 1
|
|
#define UX_SLAVE_CLASS_DFU_MEDIA_STATUS_ERROR 2
|
|
|
|
/* Define DFU thread event signals. */
|
|
#define UX_DEVICE_CLASS_DFU_THREAD_EVENT_DISCONNECT 0x1u
|
|
#define UX_DEVICE_CLASS_DFU_THREAD_EVENT_WAIT_RESET 0x2u
|
|
|
|
/* Define Slave DFU Class Calling Parameter structure */
|
|
|
|
typedef struct UX_SLAVE_CLASS_DFU_PARAMETER_STRUCT
|
|
{
|
|
|
|
ULONG ux_slave_class_dfu_parameter_will_detach;
|
|
ULONG ux_slave_class_dfu_parameter_capabilities;
|
|
VOID (*ux_slave_class_dfu_parameter_instance_activate)(VOID *);
|
|
VOID (*ux_slave_class_dfu_parameter_instance_deactivate)(VOID *);
|
|
UINT (*ux_slave_class_dfu_parameter_read)(VOID *dfu, ULONG block_number, UCHAR * data_pointer, ULONG length, ULONG *actual_length);
|
|
UINT (*ux_slave_class_dfu_parameter_write)(VOID *dfu, ULONG block_number, UCHAR * data_pointer, ULONG length, ULONG *media_status);
|
|
UINT (*ux_slave_class_dfu_parameter_get_status)(VOID *dfu, ULONG *media_status);
|
|
UINT (*ux_slave_class_dfu_parameter_notify)(VOID *dfu, ULONG notification);
|
|
#ifdef UX_DEVICE_CLASS_DFU_CUSTOM_REQUEST_ENABLE
|
|
UINT (*ux_device_class_dfu_parameter_custom_request)(VOID *dfu, UX_SLAVE_TRANSFER *transfer);
|
|
#endif
|
|
UCHAR *ux_slave_class_dfu_parameter_framework;
|
|
ULONG ux_slave_class_dfu_parameter_framework_length;
|
|
|
|
} UX_SLAVE_CLASS_DFU_PARAMETER;
|
|
|
|
/* Define DFU Class structure. */
|
|
|
|
typedef struct UX_SLAVE_CLASS_DFU_STRUCT
|
|
{
|
|
UX_SLAVE_INTERFACE *ux_slave_class_dfu_interface;
|
|
ULONG ux_slave_class_dfu_status;
|
|
VOID (*ux_slave_class_dfu_instance_activate)(VOID *);
|
|
VOID (*ux_slave_class_dfu_instance_deactivate)(VOID *);
|
|
UINT (*ux_slave_class_dfu_read)(VOID *dfu, ULONG block_number, UCHAR * data_pointer, ULONG length, ULONG *actual_length);
|
|
UINT (*ux_slave_class_dfu_write)(VOID *dfu, ULONG block_number, UCHAR * data_pointer, ULONG length, ULONG *media_status);
|
|
UINT (*ux_slave_class_dfu_get_status)(VOID *dfu, ULONG *media_status);
|
|
UINT (*ux_slave_class_dfu_notify)(VOID *dfu, ULONG notification);
|
|
#ifdef UX_DEVICE_CLASS_DFU_CUSTOM_REQUEST_ENABLE
|
|
UINT (*ux_device_class_dfu_custom_request)(VOID *dfu, UX_SLAVE_TRANSFER *transfer);
|
|
#endif
|
|
|
|
#if !defined(UX_DEVICE_STANDALONE)
|
|
UX_THREAD ux_slave_class_dfu_thread;
|
|
UCHAR *ux_slave_class_dfu_thread_stack;
|
|
UX_EVENT_FLAGS_GROUP ux_slave_class_dfu_event_flags_group;
|
|
#else
|
|
ULONG ux_device_class_dfu_flags;
|
|
#endif
|
|
} UX_SLAVE_CLASS_DFU;
|
|
|
|
#if !defined(UX_DEVICE_STANDALONE)
|
|
#define _ux_device_class_dfu_event_flags_set(dfu, flags) do { \
|
|
_ux_utility_event_flags_set(&(dfu) -> ux_slave_class_dfu_event_flags_group, flags, UX_OR); \
|
|
} while(0)
|
|
#else
|
|
#define _ux_device_class_dfu_event_flags_set(dfu, flags) do { \
|
|
(dfu) -> ux_device_class_dfu_flags |= flags; \
|
|
} while(0)
|
|
#endif
|
|
|
|
/* Define Device DFU Class prototypes. */
|
|
|
|
UINT _ux_device_class_dfu_activate(UX_SLAVE_CLASS_COMMAND *command);
|
|
UINT _ux_device_class_dfu_control_request(UX_SLAVE_CLASS_COMMAND *command);
|
|
UINT _ux_device_class_dfu_deactivate(UX_SLAVE_CLASS_COMMAND *command);
|
|
UINT _ux_device_class_dfu_entry(UX_SLAVE_CLASS_COMMAND *command);
|
|
UINT _ux_device_class_dfu_initialize(UX_SLAVE_CLASS_COMMAND *command);
|
|
VOID _ux_device_class_dfu_thread(ULONG dfu_class);
|
|
|
|
UCHAR _ux_device_class_dfu_state_get(UX_SLAVE_CLASS_DFU *dfu);
|
|
VOID _ux_device_class_dfu_state_sync(UX_SLAVE_CLASS_DFU *dfu);
|
|
|
|
UINT _ux_device_class_dfu_tasks_run(VOID *class_instance);
|
|
|
|
UINT _uxe_device_class_dfu_initialize(UX_SLAVE_CLASS_COMMAND *command);
|
|
|
|
/* Define Device DFU Class API prototypes. */
|
|
#define ux_device_class_dfu_entry _ux_device_class_dfu_entry
|
|
#define ux_device_class_dfu_state_get _ux_device_class_dfu_state_get
|
|
#define ux_device_class_dfu_state_sync _ux_device_class_dfu_state_sync
|
|
|
|
/* Determine if a C++ compiler is being used. If so, complete the standard
|
|
C conditional started above. */
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* UX_DEVICE_CLASS_DFU_H */
|