Skip to content

Commit 12a1d0e

Browse files
hathachhathach
committed
use tu_desc_in_bounds() for descriptor loop
1 parent 9030fe4 commit 12a1d0e

File tree

4 files changed

+49
-50
lines changed

4 files changed

+49
-50
lines changed

‎src/class/midi/midi_host.c‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,7 @@ bool midih_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t result, uint
197197
//--------------------------------------------------------------------+
198198
bool midih_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *desc_itf, uint16_t max_len) {
199199
(void) rhport;
200+
200201
TU_VERIFY(TUSB_CLASS_AUDIO == desc_itf->bInterfaceClass);
201202
const uint8_t *p_end = ((const uint8_t *) desc_itf) + max_len;
202203
const uint8_t *p_desc = (const uint8_t *) desc_itf;
@@ -210,9 +211,8 @@ bool midih_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *d
210211
desc_cb.jack_num = 0;
211212

212213
// There can be just a MIDI or an Audio + MIDI interface
213-
// If there is Audio Control Interface + Audio Header descriptor, then skip it.
214-
// If there is an Audio Control Interface + Audio Streaming Interface, then
215-
// ignore the Audio Streaming Interface.
214+
// - If there is Audio Control Interface + Audio Header descriptor, then skip it.
215+
// - If there is an Audio Control Interface + Audio Streaming Interface, then ignore the Audio Streaming Interface.
216216
// Future:
217217
// Note that if this driver is used with an USB Audio Streaming host driver,
218218
// then call that driver first. If the MIDI interface comes before the
@@ -230,19 +230,20 @@ bool midih_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *d
230230
p_desc = tu_desc_next(p_desc);
231231
desc_itf = (const tusb_desc_interface_t *)p_desc;
232232
p_midi->itf_count = 1;
233-
// See issue #3159
234-
while ((p_desc < p_end) && (tu_desc_next(p_desc) <= p_end) && (desc_itf->bDescriptorType != TUSB_DESC_INTERFACE || (desc_itf->bInterfaceClass == TUSB_CLASS_AUDIO && desc_itf->bInterfaceSubClass != AUDIO_SUBCLASS_MIDI_STREAMING)))
235-
{
233+
// skip non-interface and non-midi streaming descriptors
234+
while (tu_desc_in_bounds(p_desc, p_end) &&
235+
(desc_itf->bDescriptorType != TUSB_DESC_INTERFACE || (desc_itf->bInterfaceClass == TUSB_CLASS_AUDIO && desc_itf->bInterfaceSubClass != AUDIO_SUBCLASS_MIDI_STREAMING))) {
236236
if (desc_itf->bDescriptorType == TUSB_DESC_INTERFACE && desc_itf->bAlternateSetting == 0) {
237237
p_midi->itf_count++;
238238
}
239239
p_desc = tu_desc_next(p_desc);
240240
desc_itf = (tusb_desc_interface_t const *)p_desc;
241241
}
242-
TU_VERIFY(p_desc < p_end); // If MIDI interface comes after Audio Streaming, then max_len did not include the MIDI interface descriptor
242+
TU_VERIFY(p_desc < p_end); // TODO: If MIDI interface comes after Audio Streaming, then max_len did not include the MIDI interface descriptor
243243
TU_VERIFY(TUSB_CLASS_AUDIO == desc_itf->bInterfaceClass);
244-
}
244+
}
245245
TU_VERIFY(AUDIO_SUBCLASS_MIDI_STREAMING == desc_itf->bInterfaceSubClass);
246+
246247
TU_LOG_DRV("MIDI opening Interface %u (addr = %u)\r\n", desc_itf->bInterfaceNumber, dev_addr);
247248
p_midi->bInterfaceNumber = desc_itf->bInterfaceNumber;
248249
p_midi->iInterface = desc_itf->iInterface;
@@ -252,7 +253,7 @@ bool midih_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *d
252253
p_desc = tu_desc_next(p_desc); // next to CS Header
253254

254255
bool found_new_interface = false;
255-
while ((p_desc < p_end) && (tu_desc_next(p_desc) <= p_end) && !found_new_interface) {
256+
while (tu_desc_in_bounds(p_desc, p_end) && !found_new_interface) {
256257
switch (tu_desc_type(p_desc)) {
257258
case TUSB_DESC_INTERFACE:
258259
found_new_interface = true;

‎src/class/vendor/vendor_device.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ uint16_t vendord_open(uint8_t rhport, const tusb_desc_interface_t* desc_itf, uin
211211
TU_VERIFY(p_vendor, 0);
212212

213213
p_vendor->itf_num = desc_itf->bInterfaceNumber;
214-
while (tu_desc_is_valid(p_desc, desc_end)) {
214+
while (tu_desc_in_bounds(p_desc, desc_end)) {
215215
const uint8_t desc_type = tu_desc_type(p_desc);
216216
if (desc_type == TUSB_DESC_INTERFACE || desc_type == TUSB_DESC_INTERFACE_ASSOCIATION) {
217217
break; // end of this interface

‎src/common/tusb_common.h‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,44 @@ TU_ATTR_ALWAYS_INLINE static inline void tu_unaligned_write16(void *mem, uint16_
324324
+ TU_BIN8(dlsb))
325325
#endif
326326

327+
//--------------------------------------------------------------------+
328+
// Descriptor helper
329+
//--------------------------------------------------------------------+
330+
331+
// return next descriptor
332+
TU_ATTR_ALWAYS_INLINE static inline uint8_t const * tu_desc_next(void const* desc) {
333+
uint8_t const* desc8 = (uint8_t const*) desc;
334+
return desc8 + desc8[DESC_OFFSET_LEN];
335+
}
336+
337+
// get descriptor length
338+
TU_ATTR_ALWAYS_INLINE static inline uint8_t tu_desc_len(void const* desc) {
339+
return ((uint8_t const*) desc)[DESC_OFFSET_LEN];
340+
}
341+
342+
// get descriptor type
343+
TU_ATTR_ALWAYS_INLINE static inline uint8_t tu_desc_type(void const* desc) {
344+
return ((uint8_t const*) desc)[DESC_OFFSET_TYPE];
345+
}
346+
347+
// get descriptor subtype
348+
TU_ATTR_ALWAYS_INLINE static inline uint8_t tu_desc_subtype(void const* desc) {
349+
return ((uint8_t const*) desc)[DESC_OFFSET_SUBTYPE];
350+
}
351+
352+
TU_ATTR_ALWAYS_INLINE static inline uint8_t tu_desc_in_bounds(uint8_t const* p_desc, uint8_t const* desc_end) {
353+
return (p_desc < desc_end) && (tu_desc_next(p_desc) <= desc_end);
354+
}
355+
356+
// find descriptor that match byte1 (type)
357+
uint8_t const * tu_desc_find(uint8_t const* desc, uint8_t const* end, uint8_t byte1);
358+
359+
// find descriptor that match byte1 (type) and byte2
360+
uint8_t const * tu_desc_find2(uint8_t const* desc, uint8_t const* end, uint8_t byte1, uint8_t byte2);
361+
362+
// find descriptor that match byte1 (type) and byte2
363+
uint8_t const * tu_desc_find3(uint8_t const* desc, uint8_t const* end, uint8_t byte1, uint8_t byte2, uint8_t byte3);
364+
327365
#ifdef __cplusplus
328366
}
329367
#endif

‎src/common/tusb_types.h‎

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -562,46 +562,6 @@ TU_ATTR_ALWAYS_INLINE static inline const char *tu_edpt_type_str(tusb_xfer_type_
562562
}
563563
#endif
564564

565-
//--------------------------------------------------------------------+
566-
// Descriptor helper
567-
//--------------------------------------------------------------------+
568-
569-
// return next descriptor
570-
TU_ATTR_ALWAYS_INLINE static inline uint8_t const * tu_desc_next(void const* desc) {
571-
uint8_t const* desc8 = (uint8_t const*) desc;
572-
return desc8 + desc8[DESC_OFFSET_LEN];
573-
}
574-
575-
// get descriptor length
576-
TU_ATTR_ALWAYS_INLINE static inline uint8_t tu_desc_len(void const* desc) {
577-
return ((uint8_t const*) desc)[DESC_OFFSET_LEN];
578-
}
579-
580-
// get descriptor type
581-
TU_ATTR_ALWAYS_INLINE static inline uint8_t tu_desc_type(void const* desc) {
582-
return ((uint8_t const*) desc)[DESC_OFFSET_TYPE];
583-
}
584-
585-
// get descriptor subtype
586-
TU_ATTR_ALWAYS_INLINE static inline uint8_t tu_desc_subtype(void const* desc) {
587-
return ((uint8_t const*) desc)[DESC_OFFSET_SUBTYPE];
588-
}
589-
590-
TU_ATTR_ALWAYS_INLINE static inline uint8_t tu_desc_is_valid(void const* desc, uint8_t const* desc_end) {
591-
const uint8_t* desc8 = (uint8_t const*) desc;
592-
return (desc8 < desc_end) && (tu_desc_next(desc) <= desc_end);
593-
}
594-
595-
596-
// find descriptor that match byte1 (type)
597-
uint8_t const * tu_desc_find(uint8_t const* desc, uint8_t const* end, uint8_t byte1);
598-
599-
// find descriptor that match byte1 (type) and byte2
600-
uint8_t const * tu_desc_find2(uint8_t const* desc, uint8_t const* end, uint8_t byte1, uint8_t byte2);
601-
602-
// find descriptor that match byte1 (type) and byte2
603-
uint8_t const * tu_desc_find3(uint8_t const* desc, uint8_t const* end, uint8_t byte1, uint8_t byte2, uint8_t byte3);
604-
605565
#ifdef __cplusplus
606566
}
607567
#endif

0 commit comments

Comments
 (0)