USBX/App/ux_user.h (Ux_Device_CDC_ACM)

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

/**************************************************************************/ /* */ /* 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 */ /** */ /** User Specific */ /** */ /**************************************************************************/ /**************************************************************************/ /**************************************************************************/ /* */ /* PORT SPECIFIC C INFORMATION RELEASE */ /* */ /* ux_user.h PORTABLE C */ /* 6.0 */ /* */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This file contains user defines for configuring USBX in specific */ /* ways. This file will have an effect only if the application and */ /* USBX library are built with UX_INCLUDE_USER_DEFINE_FILE defined. */ /* Note that all the defines in this file may also be made on the */ /* command line when building USBX library and application objects. */ /* */ /* RELEASE HISTORY */ /* */ /* DATE NAME DESCRIPTION */ /* */ /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */ /* */ /**************************************************************************/ #ifndef UX_USER_H #define UX_USER_H /* Define various build options for the USBX port. The application should either make changes here by commenting or un-commenting the conditional compilation defined OR supply the defines though the compiler's equivalent of the -D option. */ /* #define UX_THREAD_STACK_SIZE (2 * 1024) */ /* Define USBX Host Enum Thread Stack Size. The default is to use UX_THREAD_STACK_SIZE */ /* #define UX_HOST_ENUM_THREAD_STACK_SIZE UX_THREAD_STACK_SIZE */ /* Define USBX Host Thread Stack Size. The default is to use UX_THREAD_STACK_SIZE */ /* #define UX_HOST_HCD_THREAD_STACK_SIZE UX_THREAD_STACK_SIZE */ /* Define USBX Host HNP Polling Thread Stack Size. The default is to use UX_THREAD_STACK_SIZE */ /* #define UX_HOST_HNP_POLLING_THREAD_STACK UX_THREAD_STACK_SIZE */ /* Override various options with default values already assigned in ux_api.h or ux_port.h. Please also refer to ux_port.h for descriptions on each of these options. */ /* Defined, this value represents how many ticks per seconds for a specific hardware platform. The default is 1000 indicating 1 tick per millisecond. */ /* #define UX_PERIODIC_RATE (TX_TIMER_TICKS_PER_SECOND)*/ /* Defined, this value is the maximum number of classes that can be loaded by USBX. This value represents the class container and not the number of instances of a class. For instance, if a particular implementation of USBX needs the hub class, the printer class, and the storage class, then the UX_MAX_CLASSES value can be set to 3 regardless of the number of devices that belong to these classes. */ /* #define UX_MAX_CLASS_DRIVER 3 */ /* Defined, this value is the maximum number of classes in the device stack that can be loaded by USBX. */ #define UX_MAX_SLAVE_CLASS_DRIVER 1 /* Defined, this value is the maximum number of interfaces in the device framework. */ /* #define UX_MAX_SLAVE_INTERFACES 16 */ /* Defined, this value represents the number of different host controllers available in the system. For USB 1.1 support, this value will usually be 1. For USB 2.0 support, this value can be more than 1. This value represents the number of concurrent host controllers running at the same time. If for instance there are two instances of OHCI running, or one EHCI and one OHCI controller running, the UX_MAX_HCD should be set to 2. */ /* #define UX_MAX_HCD 1 */ /* Defined, this value represents the maximum number of devices that can be attached to the USB. Normally, the theoretical maximum number on a single USB is 127 devices. This value can be scaled down to conserve memory. Note that this value represents the total number of devices regardless of the number of USB buses in the system. */ /* #define UX_MAX_DEVICES 127 */ /* Defined, this value represents the current number of SCSI logical units represented in the device storage class driver. */ /* #define UX_MAX_SLAVE_LUN 1 */ /* Defined, this value represents the maximum number of SCSI logical units represented in the host storage class driver. */ /* #define UX_MAX_HOST_LUN 1 */ /* Defined, this value represents the maximum number of bytes received on a control endpoint in the device stack. The default is 256 bytes but can be reduced in memory constraint environments. */ /* #define UX_SLAVE_REQUEST_CONTROL_MAX_LENGTH 256 */ /* Defined, this value represents the maximum number of bytes that can be received or transmitted on any endpoint. This value cannot be less than the maximum packet size of any endpoint. The default is 4096 bytes but can be reduced in memory constraint environments. For cd-rom support in the storage class, this value cannot be less than 2048. */ #define UX_SLAVE_REQUEST_DATA_MAX_LENGTH 512 /* Defined, this value includes code to handle storage Multi-Media Commands (MMC). E.g., DVD-ROM. */ /* #define UX_SLAVE_CLASS_STORAGE_INCLUDE_MMC */ /* Defined, this value represents the maximum number of bytes that a storage payload can send/receive. The default is 8K bytes but can be reduced in memory constraint environments. */ /* #define UX_HOST_CLASS_STORAGE_MEMORY_BUFFER_SIZE 8192 */ /* Define USBX Mass Storage Thread Stack Size. The default is to use UX_THREAD_STACK_SIZE. */ /* #define UX_HOST_CLASS_STORAGE_THREAD_STACK_SIZE UX_THREAD_STACK_SIZE */ /* Defined, this value represents the maximum number of Ed, regular TDs and Isochronous TDs. These values depend on the type of host controller and can be reduced in memory constraint environments. */ /* #define UX_MAX_ED 80 */ /* #define UX_MAX_TD 128 */ /* #define UX_MAX_ISO_TD 1 */ /* Defined, this value represents the maximum size of the HID decompressed buffer. This cannot be determined in advance so we allocate a big block, usually 4K but for simple HID devices like keyboard and mouse it can be reduced a lot. */ /* #define UX_HOST_CLASS_HID_DECOMPRESSION_BUFFER 4096 */ /* Defined, this value represents the maximum number of HID usages for a HID device. Default is 2048 but for simple HID devices like keyboard and mouse it can be reduced a lot. */ /* #define UX_HOST_CLASS_HID_USAGES 2048 */ /* By default, each key in each HID report from the device is reported by ux_host_class_hid_keyboard_key_get (a HID report from the device is received whenever there is a change in a key state i.e. when a key is pressed or released. The report contains every key that is down). There are limitations to this method such as not being able to determine when a key has been released. Defined, this value causes ux_host_class_hid_keyboard_key_get to only report key changes i.e. key presses and key releases. */ /* #define UX_HOST_CLASS_HID_KEYBOARD_EVENTS_KEY_CHANGES_MODE */ /* Works when UX_HOST_CLASS_HID_KEYBOARD_EVENTS_KEY_CHANGES_MODE is defined. Defined, this value causes ux_host_class_hid_keyboard_key_get to only report key pressed/down changes; key released/up changes are not reported. */ /* #define UX_HOST_CLASS_HID_KEYBOARD_EVENTS_KEY_CHANGES_MODE_REPORT_KEY_DOWN_ONLY */ /* Works when UX_HOST_CLASS_HID_KEYBOARD_EVENTS_KEY_CHANGES_MODE is defined. Defined, this value causes ux_host_class_hid_keyboard_key_get to report lock key (CapsLock/NumLock/ScrollLock) changes. */ /* #define UX_HOST_CLASS_HID_KEYBOARD_EVENTS_KEY_CHANGES_MODE_REPORT_LOCK_KEYS */ /* Works when UX_HOST_CLASS_HID_KEYBOARD_EVENTS_KEY_CHANGES_MODE is defined. Defined, this value causes ux_host_class_hid_keyboard_key_get to report modifier key (Ctrl/Alt/Shift/GUI) changes. */ /* #define UX_HOST_CLASS_HID_KEYBOARD_EVENTS_KEY_CHANGES_MODE_REPORT_MODIFIER_KEYS */ /* Defined, this value represents the maximum number of media for the host storage class. Default is 8 but for memory constrained resource systems this can ne reduced to 1. */ /* #define UX_HOST_CLASS_STORAGE_MAX_MEDIA 2 */ /* Defined, this value includes code to handle storage devices that use the CB or CBI protocol (such as floppy disks). It is off by default because these protocols are obsolete, being superseded by the Bulk Only Transport (BOT) protocol which virtually all modern storage devices use. */ /* #define UX_HOST_CLASS_STORAGE_INCLUDE_LEGACY_PROTOCOL_SUPPORT */ /* Defined, this value forces the memory allocation scheme to enforce alignment of memory with the UX_SAFE_ALIGN field. */ /* #define UX_ENFORCE_SAFE_ALIGNMENT */ /* Defined, this value represents the number of packets in the CDC_ECM device class. The default is 16. */ /* #define UX_DEVICE_CLASS_CDC_ECM_NX_PKPOOL_ENTRIES 4 */ /* Defined, this value represents the number of packets in the CDC_ECM host class. The default is 16. */ /* #define UX_HOST_CLASS_CDC_ECM_NX_PKPOOL_ENTRIES 16 */ /* Defined, this value represents the number of milliseconds to wait for packet allocation until invoking the application's error callback and retrying. The default is 1000 milliseconds. */ /* #define UX_HOST_CLASS_CDC_ECM_PACKET_POOL_WAIT 10 */ /* Defined, this value represents the number of milliseconds to wait for packet allocation until invoking the application's error callback and retrying. */ /* #define UX_DEVICE_CLASS_CDC_ECM_PACKET_POOL_WAIT 1000 */ /* Defined, this value represents the the maximum length of HID reports on the device. */ /* #define UX_DEVICE_CLASS_HID_EVENT_BUFFER_LENGTH 64 */ /* Defined, this value represents the the maximum number of HID events/reports that can be queued at once. */ /* #define UX_DEVICE_CLASS_HID_MAX_EVENTS_QUEUE 8 */ /* Defined, this macro will disable DFU_UPLOAD support. */ /* #define UX_DEVICE_CLASS_DFU_UPLOAD_DISABLE */ /* Defined, this macro will enable DFU_GETSTATUS and DFU_GETSTATE in dfuERROR. */ /* #define UX_DEVICE_CLASS_DFU_ERROR_GET_ENABLE */ /* Defined, this macro will change status mode. 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. */ #define UX_DEVICE_CLASS_DFU_STATUS_MODE 1 /* Defined, this value represents the default DFU status bwPollTimeout. The value is 3 bytes long (max 0xFFFFFFu). By default the bwPollTimeout is 1 (means 1ms). */ #define UX_DEVICE_CLASS_DFU_STATUS_POLLTIMEOUT 0 /* Defined, this macro will enable custom request process callback. */ /* #define UX_DEVICE_CLASS_DFU_CUSTOM_REQUEST_ENABLE */ /* Defined, this value will only enable the host side of usbx. */ /* #define UX_HOST_SIDE_ONLY */ #define UX_DEVICE_SIDE_ONLY /* Defined, this value will include the OTG polling thread. OTG can only be active if both host/device are present. */ #ifndef UX_HOST_SIDE_ONLY #ifndef UX_DEVICE_SIDE_ONLY /* #define UX_OTG_SUPPORT */ #endif #endif /* Defined, this value represents the maximum size of single tansfers for the SCSI data phase. */ /* #define UX_HOST_CLASS_STORAGE_MAX_TRANSFER_SIZE (1024 * 1) */ /* Defined, this value represents the size of the log pool. */ /* #define UX_DEBUG_LOG_SIZE (1024 * 16) */ /* This is the ThreadX priority value for the USBX enumeration threads that monitors the bus topology */ /* #define UX_THREAD_PRIORITY_ENUM 20 */ /* This is the ThreadX priority value for the standard USBX threads */ /* #define UX_THREAD_PRIORITY_CLASS 20 */ /* This is the ThreadX priority value for the USBX HID keyboard class. */ /* #define UX_THREAD_PRIORITY_KEYBOARD 20 */ /* This is the ThreadX priority value for the host controller thread. */ /* #define UX_THREAD_PRIORITY_HCD 2 */ /* This value actually defines the time slice that will be used for threads. For example, if defined to 0, the ThreadX target port does not use time slices. */ /* #define UX_NO_TIME_SLICE 0 */ /* it define USBX device max number of endpoints (1~n). */ /* #define UX_MAX_DEVICE_ENDPOINTS 6 */ /* it define USBX device max number of interfacess (1~n). */ /* #define UX_MAX_DEVICE_INTERFACES 6 */ /* Define USBX max TT. */ /* #define UX_MAX_TT 8 */ /* Determine if tracing is enabled. */ /*#define UX_TRACE_INSERT_MACROS*/ #endif