Skip to content

Commit 6c30229

Browse files
facchinmfacchinm
committed
allow HID submodules to create runtime descriptors
with this PR you can add \#include Keyboard.h \#include Mouse.h \#include HID.h in the top of the sketch and you will expose a Mouse+Keyboard From the library pow, simply add static HID_Descriptor cb = { .length = sizeof(_hidReportDescriptor), .descriptor = _hidReportDescriptor, }; static HIDDescriptorListNode node(&cb); HID.AppendDescriptor(&node); in the class' constructor and you are done!
1 parent ccc0d3a commit 6c30229

File tree

6 files changed

+85
-52
lines changed

6 files changed

+85
-52
lines changed

‎hardware/arduino/avr/libraries/HID/HID.cpp

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ static u8 HID_INTERFACE;
4444

4545
HIDDescriptor _hidInterface;
4646

47+
static HIDDescriptorListNode* rootNode = NULL;
48+
static uint8_t sizeof_hidReportDescriptor = 0;
49+
static uint8_t modules_count = 0;
4750
//================================================================================
4851
//================================================================================
4952
// Driver
@@ -54,18 +57,45 @@ u8 _hid_idle = 1;
5457
int HID_GetInterface(u8* interfaceNum)
5558
{
5659
interfaceNum[0] += 1; // uses 1
60+
_hidInterface =
61+
{
62+
D_INTERFACE(HID_INTERFACE,1,3,0,0),
63+
D_HIDREPORT(sizeof_hidReportDescriptor),
64+
D_ENDPOINT(USB_ENDPOINT_IN (HID_ENDPOINT_INT),USB_ENDPOINT_TYPE_INTERRUPT,0x40,0x01)
65+
};
5766
return USB_SendControl(0,&_hidInterface,sizeof(_hidInterface));
5867
}
5968

6069
int HID_GetDescriptor(int8_t t)
6170
{
6271
if (HID_REPORT_DESCRIPTOR_TYPE == t) {
63-
return USB_SendControl(TRANSFER_PGM,_hidReportDescriptor,getsizeof_hidReportDescriptor());
72+
HIDDescriptorListNode* current = rootNode;
73+
int total = 0;
74+
while(current != NULL) {
75+
total += USB_SendControl(TRANSFER_PGM,current->cb->descriptor,current->cb->length);
76+
current = current->next;
77+
}
78+
return total;
6479
} else {
6580
return 0;
6681
}
6782
}
6883

84+
void HID_::AppendDescriptor(HIDDescriptorListNode *node)
85+
{
86+
if (modules_count == 0) {
87+
rootNode = node;
88+
} else {
89+
HIDDescriptorListNode *current = rootNode;
90+
while(current->next != NULL) {
91+
current = current->next;
92+
}
93+
current->next = node;
94+
}
95+
modules_count++;
96+
sizeof_hidReportDescriptor += node->cb->length;
97+
}
98+
6999
void HID_::SendReport(u8 id, const void* data, int len)
70100
{
71101
USB_Send(HID_TX, &id, 1);
@@ -129,13 +159,6 @@ HID_::HID_(void)
129159
static PUSBListNode node(&cb);
130160

131161
HID_ENDPOINT_INT = PUSB_AddFunction(&node, &HID_INTERFACE);
132-
133-
_hidInterface =
134-
{
135-
D_INTERFACE(HID_INTERFACE,1,3,0,0),
136-
D_HIDREPORT(getsizeof_hidReportDescriptor()),
137-
D_ENDPOINT(USB_ENDPOINT_IN (HID_ENDPOINT_INT),USB_ENDPOINT_TYPE_INTERRUPT,0x40,0x01)
138-
};
139162
}
140163

141164
int HID_::begin(void)

‎hardware/arduino/avr/libraries/HID/HID.h

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,27 @@
4040
#define HID_REPORT_DESCRIPTOR_TYPE 0x22
4141
#define HID_PHYSICAL_DESCRIPTOR_TYPE 0x23
4242

43+
typedef struct __attribute__((packed)) {
44+
u8 length;
45+
const void* descriptor;
46+
} HID_Descriptor;
47+
48+
class HIDDescriptorListNode {
49+
public:
50+
HIDDescriptorListNode *next = NULL;
51+
const HID_Descriptor * cb;
52+
HIDDescriptorListNode(const HID_Descriptor *ncb) {cb = ncb;}
53+
};
54+
4355
class HID_
4456
{
4557
public:
4658
HID_(void);
4759
int begin(void);
4860
void SendReport(uint8_t id, const void* data, int len);
61+
void AppendDescriptor(HIDDescriptorListNode* node);
4962
};
5063

51-
extern HID_ HID;
52-
5364
typedef struct
5465
{
5566
u8 len; // 9
@@ -75,11 +86,6 @@ typedef struct
7586
#define D_HIDREPORT(_descriptorLength) \
7687
{ 9, 0x21, 0x1, 0x1, 0, 1, 0x22, _descriptorLength, 0 }
7788

78-
extern const u8 _hidReportDescriptor[] PROGMEM;
79-
80-
// MUST be declared by the module
81-
size_t getsizeof_hidReportDescriptor();
82-
8389
#define WEAK __attribute__ ((weak))
8490

8591
#endif

‎libraries/Keyboard/Keyboard.cpp

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,12 @@
11
#if 1
22

3-
#include "HID.h"
43
#include "Keyboard.h"
54

65
//================================================================================
76
//================================================================================
87
// Keyboard
98

10-
Keyboard_ Keyboard;
11-
12-
Keyboard_::Keyboard_(void)
13-
{
14-
}
15-
16-
void Keyboard_::begin(void)
17-
{
18-
}
19-
20-
void Keyboard_::end(void)
21-
{
22-
}
23-
24-
void Keyboard_::sendReport(KeyReport* keys)
25-
{
26-
HID.SendReport(2,keys,sizeof(KeyReport));
27-
}
28-
29-
const u8 _hidReportDescriptor[] PROGMEM = {
9+
static const u8 _hidReportDescriptor[] PROGMEM = {
3010

3111
// Keyboard
3212
0x05, 0x01, // USAGE_PAGE (Generic Desktop) // 47
@@ -59,6 +39,29 @@ const u8 _hidReportDescriptor[] PROGMEM = {
5939
0xc0, // END_COLLECTION
6040
};
6141

42+
Keyboard_::Keyboard_(void)
43+
{
44+
static HID_Descriptor cb = {
45+
.length = sizeof(_hidReportDescriptor),
46+
.descriptor = _hidReportDescriptor,
47+
};
48+
static HIDDescriptorListNode node(&cb);
49+
HID.AppendDescriptor(&node);
50+
}
51+
52+
void Keyboard_::begin(void)
53+
{
54+
}
55+
56+
void Keyboard_::end(void)
57+
{
58+
}
59+
60+
void Keyboard_::sendReport(KeyReport* keys)
61+
{
62+
HID.SendReport(2,keys,sizeof(KeyReport));
63+
}
64+
6265
extern
6366
const uint8_t _asciimap[128] PROGMEM;
6467

@@ -196,9 +199,6 @@ const uint8_t _asciimap[128] =
196199
0 // DEL
197200
};
198201

199-
size_t getsizeof_hidReportDescriptor() {
200-
return sizeof(_hidReportDescriptor);
201-
}
202202

203203
uint8_t USBPutChar(uint8_t c);
204204

@@ -300,4 +300,6 @@ size_t Keyboard_::write(uint8_t c)
300300
return p; // just return the result of press() since release() almost always returns 1
301301
}
302302

303+
Keyboard_ Keyboard;
304+
303305
#endif

‎libraries/Keyboard/Keyboard.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#ifndef KEYBOARD_h
22
#define KEYBOARD_h
33

4-
#if defined(_USING_HID)
4+
#if 0 //defined(_USING_HID)
55

66
#error "Can only attach one submodule to HID module"
77

@@ -69,10 +69,10 @@ class Keyboard_ : public Print
6969
Keyboard_(void);
7070
void begin(void);
7171
void end(void);
72-
virtual size_t write(uint8_t k);
73-
virtual size_t press(uint8_t k);
74-
virtual size_t release(uint8_t k);
75-
virtual void releaseAll(void);
72+
size_t write(uint8_t k);
73+
size_t press(uint8_t k);
74+
size_t release(uint8_t k);
75+
void releaseAll(void);
7676
};
7777
extern Keyboard_ Keyboard;
7878
extern HID_ HID;

‎libraries/Mouse/Mouse.cpp

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
#include "Mouse.h"
44

5-
const u8 _hidReportDescriptor[] PROGMEM = {
5+
static const u8 _hidReportDescriptor[] PROGMEM = {
66

77
// Mouse
88
0x05, 0x01, // USAGE_PAGE (Generic Desktop) // 54
@@ -35,18 +35,18 @@ const u8 _hidReportDescriptor[] PROGMEM = {
3535
0xc0, // END_COLLECTION
3636
};
3737

38-
size_t getsizeof_hidReportDescriptor() {
39-
return sizeof(_hidReportDescriptor);
40-
}
41-
42-
Mouse_ Mouse;
43-
4438
//================================================================================
4539
//================================================================================
4640
// Mouse
4741

4842
Mouse_::Mouse_(void) : _buttons(0)
4943
{
44+
const static HID_Descriptor cb = {
45+
.length = sizeof(_hidReportDescriptor),
46+
.descriptor = _hidReportDescriptor,
47+
};
48+
static HIDDescriptorListNode node(&cb);
49+
HID.AppendDescriptor(&node);
5050
}
5151

5252
void Mouse_::begin(void)
@@ -101,4 +101,6 @@ bool Mouse_::isPressed(uint8_t b)
101101
return false;
102102
}
103103

104+
Mouse_ Mouse;
105+
104106
#endif

‎libraries/Mouse/Mouse.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#ifndef MOUSE_h
22
#define MOUSE_h
33

4-
#if defined(_USING_HID)
4+
#if 0 //defined(_USING_HID)
55

66
#error "Can only attach one submodule to HID module"
77

0 commit comments

Comments
 (0)