aboutsummaryrefslogtreecommitdiffstats
path: root/usb/class/dfu/device/dfudf_desc.h
blob: f9eca3811b53a2f5a27bdc6d34d51bb1bee1b022 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/**
 * \file
 *
 * \brief USB Device Stack DFU Function Descriptor Setting.
 *
 * Copyright (c) 2015-2018 Microchip Technology Inc. and its subsidiaries.
 * Copyright (c) 2018 sysmocom -s.f.m.c. GmbH, Author: Kevin Redon <kredon@sysmocom.de>
 *
 * \asf_license_start
 *
 * \page License
 *
 * Subject to your compliance with these terms, you may use Microchip
 * software and any derivatives exclusively with Microchip products.
 * It is your responsibility to comply with third party license terms applicable
 * to your use of third party software (including open source software) that
 * may accompany Microchip software.
 *
 * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES,
 * WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE,
 * INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY,
 * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP BE
 * LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL
 * LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE
 * SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE
 * POSSIBILITY OR THE DAMAGES ARE FORESEEABLE.  TO THE FULLEST EXTENT
 * ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY
 * RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
 * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
 *
 * \asf_license_stop
 */

#ifndef USBDF_DFU_DESC_H_
#define USBDF_DFU_DESC_H_

#include "usb_protocol.h"
#include "usbd_config.h"
#include "usb_protocol_dfu.h"

#define DFUD_DEV_DESC \
	USB_DEV_DESC_BYTES(CONF_USB_DFUD_BCDUSB, \
	                   CONF_USB_DFUD_BDEVICECLASS, \
	                   CONF_USB_DFUD_BDEVICESUBCLASS, \
	                   CONF_USB_DFUD_BDEVICEPROTOCOL, \
	                   CONF_USB_DFUD_BMAXPKSZ0, \
	                   CONF_USB_OCTSIM_IDVENDOR, \
	                   CONF_USB_OCTSIM_IDPRODUCT, \
	                   CONF_USB_DFUD_BCDDEVICE, \
	                   CONF_USB_DFUD_IMANUFACT, \
	                   CONF_USB_DFUD_IPRODUCT, \
	                   CONF_USB_DFUD_ISERIALNUM, \
	                   CONF_USB_DFUD_BNUMCONFIG)

#define DFUD_DEV_QUAL_DESC \
	USB_DEV_QUAL_DESC_BYTES(CONF_USB_DFUD_BCDUSB, \
	                        CONF_USB_DFUD_BDEVICECLASS, \
	                        CONF_USB_DFUD_BDEVICESUBCLASS, \
	                        CONF_USB_DFUD_BMAXPKSZ0, \
	                        CONF_USB_DFUD_BNUMCONFIG)

#define DFUD_CFG_DESC \
	USB_CONFIG_DESC_BYTES(CONF_USB_DFUD_WTOTALLENGTH, \
	                      CONF_USB_DFUD_BNUMINTERFACES, \
	                      CONF_USB_DFUD_BCONFIGVAL, \
	                      CONF_USB_DFUD_ICONFIG, \
	                      CONF_USB_DFUD_BMATTRI, \
	                      CONF_USB_DFUD_BMAXPOWER)

#define DFUD_OTH_SPD_CFG_DESC \
	USB_OTH_SPD_CFG_DESC_BYTES(CONF_USB_DFUD_WTOTALLENGTH, \
	                           CONF_USB_DFUD_BNUMINTERFACES, \
	                           CONF_USB_DFUD_BCONFIGVAL, \
	                           CONF_USB_DFUD_ICONFIG, \
	                           CONF_USB_DFUD_BMATTRI, \
	                           CONF_USB_DFUD_BMAXPOWER)

#define DFUD_IFACE_DESCES \
	USB_IFACE_DESC_BYTES(CONF_USB_DFUD_BIFCNUM, \
	                     CONF_USB_DFUD_BALTSET, \
	                     CONF_USB_DFUD_BNUMEP, \
	                     USB_DFU_CLASS, \
	                     USB_DFU_SUBCLASS, \
	                     USB_DFU_PROTOCOL_DFU, \
	                     CONF_USB_DFUD_IINTERFACE), \
	                     USB_DFU_FUNC_DESC_BYTES(USB_DFU_ATTRIBUTES_CAN_DOWNLOAD | USB_DFU_ATTRIBUTES_WILL_DETACH, \
	                     	                     200, /* maximum time in milliseconds to detach (and reboot) */ \
	                     	                     1024, /* maximum transfer size */ \
	                     	                     0x0110 /*< DFU specification version 1.1 used */ )

#define DFUD_STR_DESCES \
	CONF_USB_DFUD_LANGID_DESC \
	CONF_USB_DFUD_IMANUFACT_STR_DESC \
	CONF_USB_DFUD_IPRODUCT_STR_DESC \
	CONF_USB_DFUD_ISERIALNUM_STR_DESC \
	CONF_USB_DFUD_ICONFIG_STR_DESC \
	CONF_USB_DFUD_IINTERFACE_STR_DESC

/** USB Device descriptors and configuration descriptors */
#define DFUD_DESCES_LS_FS \
	DFUD_DEV_DESC, DFUD_CFG_DESC, DFUD_IFACE_DESCES, DFUD_STR_DESCES

#define DFUD_HS_DESCES_LS_FS \
	DFUD_DEV_DESC, DFUD_DEV_QUAL_DESC, DFUD_CFG_DESC, DFUD_M_IFACE_DESCES, \
	    DFUD_IFACE_DESCES, DFUD_OTH_SPD_CFG_DESC, \
	    DFUD_IFACE_DESCES_HS, DFUD_STR_DESCES

#define DFUD_HS_DESCES_HS \
	DFUD_CFG_DESC, DFUD_IFACE_DESCES, DFUD_IFACE_DESCES_HS, DFUD_OTH_SPD_CFG_DESC, \
	    DFUD_IFACE_DESCES

#endif /* USBDF_DFU_DESC_H_ */