src/host/hcd.h (TinyUSB Library)

Outline

#define _TUSB_HCD_H_

#include "common/tusb_common.h"

#include "osal/osal.h"

#include "common/tusb_fifo.h"

#define CFG_TUH_ENDPOINT_MAX

hcd_eventid_t

hcd_event_t

hcd_devtree_info_t

hcd_dcache_clean(const void *, uint32_t);

hcd_dcache_invalidate(const void *, uint32_t);

hcd_dcache_clean_invalidate(const void *, uint32_t);

hcd_configure(uint8_t, uint32_t, const void *);

hcd_init(uint8_t);

hcd_deinit(uint8_t);

hcd_int_handler(uint8_t, bool);

hcd_int_enable(uint8_t);

hcd_int_disable(uint8_t);

hcd_frame_number(uint8_t);

hcd_port_connect_status(uint8_t);

hcd_port_reset(uint8_t);

hcd_port_reset_end(uint8_t);

hcd_port_speed_get(uint8_t);

hcd_device_close(uint8_t, uint8_t);

hcd_edpt_open(uint8_t, uint8_t, const tusb_desc_endpoint_t *);

hcd_edpt_xfer(uint8_t, uint8_t, uint8_t, uint8_t *, uint16_t);

hcd_edpt_abort_xfer(uint8_t, uint8_t, uint8_t);

hcd_setup_send(uint8_t, uint8_t, const uint8_t *);

hcd_edpt_clear_stall(uint8_t, uint8_t, uint8_t);

hcd_devtree_get_info(uint8_t, hcd_devtree_info_t *);

hcd_event_handler(const hcd_event_t *, bool);

hcd_event_device_attach(uint8_t, bool)

hcd_event_device_remove(uint8_t, bool)

hcd_event_xfer_complete(uint8_t, uint8_t, uint32_t, xfer_result_t, bool)

Files

SourceVuRaspberry Pi Pico SDK and ExamplesTinyUSB Librarysrc/host/hcd.h

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

/* * 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. * * This file is part of the TinyUSB stack. */ #ifndef _TUSB_HCD_H_ #define _TUSB_HCD_H_ #include "common/tusb_common.h" #include "osal/osal.h" #include "common/tusb_fifo.h" #ifdef __cplusplus extern "C" { #endif //--------------------------------------------------------------------+ // Configuration //--------------------------------------------------------------------+ // Max number of endpoints pair per device // TODO optimize memory usage #ifndef CFG_TUH_ENDPOINT_MAX #define CFG_TUH_ENDPOINT_MAX 16 // #ifdef TUP_HCD_ENDPOINT_MAX // #define CFG_TUH_ENDPPOINT_MAX TUP_HCD_ENDPOINT_MAX // #else // #define // #endif #endif //--------------------------------------------------------------------+ // MACRO CONSTANT TYPEDEF //--------------------------------------------------------------------+ typedef enum { HCD_EVENT_DEVICE_ATTACH, HCD_EVENT_DEVICE_REMOVE, HCD_EVENT_XFER_COMPLETE, // Not an HCD event, just a convenient way to defer ISR function USBH_EVENT_FUNC_CALL, HCD_EVENT_COUNT } hcd_eventid_t; typedef struct { uint8_t rhport; uint8_t event_id; uint8_t dev_addr; union { // Attach, Remove struct { uint8_t hub_addr; uint8_t hub_port; uint8_t speed; } connection; // XFER_COMPLETE struct { uint8_t ep_addr; uint8_t result; uint32_t len; } xfer_complete; // FUNC_CALL struct { void (*func) (void*); void* param; }func_call; }; } hcd_event_t; typedef struct { uint8_t rhport; uint8_t hub_addr; uint8_t hub_port; uint8_t speed; } hcd_devtree_info_t; //--------------------------------------------------------------------+ // Memory API //--------------------------------------------------------------------+ // clean/flush data cache: write cache -> memory. // Required before an DMA TX transfer to make sure data is in memory bool hcd_dcache_clean(void const* addr, uint32_t data_size) TU_ATTR_WEAK; // invalidate data cache: mark cache as invalid, next read will read from memory // Required BOTH before and after an DMA RX transfer bool hcd_dcache_invalidate(void const* addr, uint32_t data_size) TU_ATTR_WEAK; // clean and invalidate data cache // Required before an DMA transfer where memory is both read/write by DMA bool hcd_dcache_clean_invalidate(void const* addr, uint32_t data_size) TU_ATTR_WEAK; //--------------------------------------------------------------------+ // Controller API //--------------------------------------------------------------------+ // optional hcd configuration, called by tuh_configure() bool hcd_configure(uint8_t rhport, uint32_t cfg_id, const void* cfg_param); // Initialize controller to host mode bool hcd_init(uint8_t rhport); // De-initialize controller bool hcd_deinit(uint8_t rhport); // Interrupt Handler void hcd_int_handler(uint8_t rhport, bool in_isr); // Enable USB interrupt void hcd_int_enable (uint8_t rhport); // Disable USB interrupt void hcd_int_disable(uint8_t rhport); // Get frame number (1ms) uint32_t hcd_frame_number(uint8_t rhport); //--------------------------------------------------------------------+ // Port API //--------------------------------------------------------------------+ // Get the current connect status of roothub port bool hcd_port_connect_status(uint8_t rhport); // Reset USB bus on the port. Return immediately, bus reset sequence may not be complete. // Some port would require hcd_port_reset_end() to be invoked after 10ms to complete the reset sequence. void hcd_port_reset(uint8_t rhport); // Complete bus reset sequence, may be required by some controllers void hcd_port_reset_end(uint8_t rhport); // Get port link speed tusb_speed_t hcd_port_speed_get(uint8_t rhport); // HCD closes all opened endpoints belong to this device void hcd_device_close(uint8_t rhport, uint8_t dev_addr); //--------------------------------------------------------------------+ // Endpoints API //--------------------------------------------------------------------+ // Open an endpoint bool hcd_edpt_open(uint8_t rhport, uint8_t daddr, tusb_desc_endpoint_t const * ep_desc); // Submit a transfer, when complete hcd_event_xfer_complete() must be invoked bool hcd_edpt_xfer(uint8_t rhport, uint8_t daddr, uint8_t ep_addr, uint8_t * buffer, uint16_t buflen); // Abort a queued transfer. Note: it can only abort transfer that has not been started // Return true if a queued transfer is aborted, false if there is no transfer to abort bool hcd_edpt_abort_xfer(uint8_t rhport, uint8_t dev_addr, uint8_t ep_addr); // Submit a special transfer to send 8-byte Setup Packet, when complete hcd_event_xfer_complete() must be invoked bool hcd_setup_send(uint8_t rhport, uint8_t daddr, uint8_t const setup_packet[8]); // clear stall, data toggle is also reset to DATA0 bool hcd_edpt_clear_stall(uint8_t rhport, uint8_t dev_addr, uint8_t ep_addr); //--------------------------------------------------------------------+ // USBH implemented API //--------------------------------------------------------------------+ // Get device tree information of a device // USB device tree can be complicated and manged by USBH, this help HCD to retrieve // needed topology info to carry out its work extern void hcd_devtree_get_info(uint8_t dev_addr, hcd_devtree_info_t* devtree_info); //------------- Event API -------------// // Called by HCD to notify stack extern void hcd_event_handler(hcd_event_t const* event, bool in_isr); // Helper to send device attach event TU_ATTR_ALWAYS_INLINE static inline void hcd_event_device_attach(uint8_t rhport, bool in_isr) { hcd_event_t event; event.rhport = rhport; event.event_id = HCD_EVENT_DEVICE_ATTACH; event.connection.hub_addr = 0; event.connection.hub_port = 0; hcd_event_handler(&event, in_isr); } // Helper to send device removal event TU_ATTR_ALWAYS_INLINE static inline void hcd_event_device_remove(uint8_t rhport, bool in_isr) { hcd_event_t event; event.rhport = rhport; event.event_id = HCD_EVENT_DEVICE_REMOVE; event.connection.hub_addr = 0; event.connection.hub_port = 0; hcd_event_handler(&event, in_isr); } // Helper to send USB transfer event TU_ATTR_ALWAYS_INLINE static inline void hcd_event_xfer_complete(uint8_t dev_addr, uint8_t ep_addr, uint32_t xferred_bytes, xfer_result_t result, bool in_isr) { hcd_event_t event = { .rhport = 0, // TODO correct rhport .event_id = HCD_EVENT_XFER_COMPLETE, .dev_addr = dev_addr, }; event.xfer_complete.ep_addr = ep_addr; event.xfer_complete.result = result; event.xfer_complete.len = xferred_bytes; hcd_event_handler(&event, in_isr); } #ifdef __cplusplus } #endif #endif /* _TUSB_HCD_H_ */

Details