summaryrefslogtreecommitdiff
path: root/cmd/sbc_harness/config/tusb_config.h
blob: 74561f3581a8241b809dea9aebccb15216b14a55 (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
/* sbc_harness/config/tusb_config.h - Compile-time configuration for the TinyUSB library
 *
 * Copyright (C) 2024  Luke T. Shumaker <lukeshu@lukeshu.com>
 * SPDX-Licence-Identifier: AGPL-3.0-or-later
 *
 * SPDX-Licence-Identifier: MIT
 * The MIT License (MIT)
 *
 * Copyright (c) 2019 Ha Thach (tinyusb.org)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

#ifndef _TUSB_CONFIG_H_
#define _TUSB_CONFIG_H_

#ifdef __cplusplus
extern "C" {
#endif

//--------------------------------------------------------------------
// TinyUSB Device (TUD) initialization for rp2040-based boards
//--------------------------------------------------------------------

// Which USB port to use for the RootHub.
// The rp2040 only has 1 port, so it's gotta be port #0.
#define BOARD_TUD_RHPORT      0

// RHPort max operational speed.
// Use OPT_MODE_DEFAULT_SPEED for max speed supported by MCU.
#define BOARD_TUD_MAX_SPEED   OPT_MODE_DEFAULT_SPEED

//--------------------------------------------------------------------
// Configuration: common
//--------------------------------------------------------------------

// defined by compiler flags
#ifndef CFG_TUSB_MCU
#error CFG_TUSB_MCU must be defined
#endif

// Conditional because it might be defined with `-D` on the command
// line if `cmake -DCMAKE_BUILD_TYPE=Debug`.
#ifndef CFG_TUSB_DEBUG
#define CFG_TUSB_DEBUG        0
#endif

// USB DMA on some MCUs can only access a specific SRAM region with restriction on alignment.
// Tinyusb use follows macros to declare transferring memory so that they can be put
// into those specific section.
// e.g
// - CFG_TUSB_MEM SECTION : __attribute__ (( section(".usb_ram") ))
// - CFG_TUSB_MEM_ALIGN   : __attribute__ ((aligned(4)))
#define CFG_TUSB_MEM_SECTION      /* blank */
#define CFG_TUSB_MEM_ALIGN        __attribute__ ((aligned(4)))

#define CFG_TUD_ENABLED       1
#define CFG_TUD_MAX_SPEED     BOARD_TUD_MAX_SPEED

//--------------------------------------------------------------------
// Configuration: TinyUSB Device (TUD)
//--------------------------------------------------------------------

// control endpoint max packet size (only 8, 16, 32, or 64 are valid)
#define CFG_TUD_ENDPOINT0_SIZE    64

// Which of TinyUSB's built-in class drivers to enable.
//
// If a class takes an int, that's the maximum number of interfaces of
// that type that may be listed in the same configuration descriptor.
#define CFG_TUD_CDC               0 // int : Communications Device Class (e.g. ttyUSB) https://www.usb.org/sites/default/files/CDC1.2_WMC1.1_012011.zip
#define CFG_TUD_MSC               0 // bool: Mass Storage Class                        https://www.usb.org/sites/default/files/Mass_Storage_Specification_Overview_v1.4_2-19-2010.pdf
#define CFG_TUD_HID               1 // int : Human Interface Device                    https://www.usb.org/sites/default/files/hid1_11.pdf
#define CFG_TUD_AUDIO             0 // int : Audio                                     https://www.usb.org/sites/default/files/audio10.pdf
#define CFG_TUD_VIDEO             0 // int : Video                                     https://www.usb.org/sites/default/files/USB_Video_Class_1_5.zip
#define CFG_TUD_MIDI              0 // int : Musical Instrument Digital Interface      https://www.usb.org/sites/default/files/USB%20MIDI%20v2_0.pdf
#define CFG_TUD_VENDOR            0 // int : ???
#define CFG_TUD_USBTMC            0 // bool: Test & Measurement Class                  https://www.usb.org/sites/default/files/USBTMC_1_006a.zip
#define CFG_TUD_DFU_RUNTIME       0 // bool: Device Firmware Upgrade                   https://www.usb.org/sites/default/files/DFU_1.1.pdf
#define CFG_TUD_DFU               0 // bool: Device Firmware Upgrade                   https://www.usb.org/sites/default/files/DFU_1.1.pdf
#define CFG_TUD_ECM_RNDIS         0 // bool: net
#define CFG_TUD_NCM               0 // bool: net
#define CFG_TUD_BTH               0 // bool: Bluetooth

// HID buffer size Should be sufficient to hold ID (if any) + Data
#define CFG_TUD_HID_EP_BUFSIZE    8

//--------------------------------------------------------------------
#ifdef __cplusplus
}
#endif

#endif /* _TUSB_CONFIG_H_ */