mirror/tinyusb
1
0
Fork 0
mirror of https://github.com/hathach/tinyusb.git synced 2025-03-29 10:20:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

remove multiple instances per device for hidh keyboard (no needed)

Browse Source 
- API retain though
This commit is contained in:
hathach 2013-03-25 22:06:00 +07:00
parent a2031e6218
commit ff03b452d9
4 changed files with 42 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
tests/test/host/hid/test_hidh_keyboard.c
View File

@ -61,29 +61,25 @@ tusb_keyboard_report_t sample_key[2] =
uint8_t dev_addr;
tusb_keyboard_report_t report;
uint8_t instance_num;
keyboard_interface_t* p_hidh_kbd_interface;
hidh_keyboard_info_t *p_hidh_kbd;
tusb_descriptor_interface_t const *p_kbd_interface_desc = &desc_configuration.keyboard_interface;
tusb_descriptor_endpoint_t const *p_kdb_endpoint_desc = &desc_configuration.keyboard_endpoint;
void setUp(void)
{
instance_num = 0;
dev_addr = RANDOM(TUSB_CFG_HOST_DEVICE_MAX)+1;
memclr_(&report, sizeof(tusb_keyboard_report_t));
dev_addr = RANDOM(TUSB_CFG_HOST_DEVICE_MAX)+1;
hidh_keyboard_init();
keyboard_data[dev_addr-1].instance_count = 1;
p_hidh_kbd_interface = &keyboard_data[dev_addr-1].instance[instance_num];
p_hidh_kbd = &keyboard_data[dev_addr-1];
p_hidh_kbd_interface->report_size = sizeof(tusb_keyboard_report_t);
p_hidh_kbd_interface->pipe_in = (pipe_handle_t) {
.dev_addr = dev_addr,
p_hidh_kbd->report_size = sizeof(tusb_keyboard_report_t);
p_hidh_kbd->pipe_hdl = (pipe_handle_t) {
.dev_addr = dev_addr,
.xfer_type = TUSB_XFER_INTERRUPT,
.index = 1
.index = 1
};
}
@ -102,10 +98,10 @@ void TEST_ASSERT_PIPE_HANDLE(pipe_handle_t x, pipe_handle_t y)
TEST_ASSERT_EQUAL(x.index , y.index);
}
void test_keyboard_no_instances_invalid_para(void)
void test_keyboard_is_supported_fail(void)
{
tusbh_device_get_state_IgnoreAndReturn(TUSB_DEVICE_STATE_UNPLUG);
TEST_ASSERT_EQUAL(0, tusbh_hid_keyboard_no_instances(dev_addr));
TEST_ASSERT_FALSE( tusbh_hid_keyboard_is_supported(dev_addr) );
}
void test_keyboard_init(void)
@ -120,20 +116,20 @@ void test_keyboard_open_ok(void)
{
uint16_t length=0;
pipe_handle_t pipe_hdl = {.dev_addr = dev_addr, .xfer_type = TUSB_XFER_INTERRUPT, .index = 2};
keyboard_interface_t* p_new_instance = &keyboard_data[dev_addr-1].instance[instance_num+1];
memclr_(p_hidh_kbd, sizeof(hidh_keyboard_info_t));
hcd_pipe_open_ExpectAndReturn(dev_addr, p_kdb_endpoint_desc, TUSB_CLASS_HID, pipe_hdl);
//------------- Code Under TEST -------------//
TEST_ASSERT_EQUAL(TUSB_ERROR_NONE, hidh_keyboard_open_subtask(dev_addr, (uint8_t*) p_kbd_interface_desc, &length));
TEST_ASSERT_PIPE_HANDLE(pipe_hdl, p_new_instance->pipe_in);
TEST_ASSERT_EQUAL(8, p_new_instance->report_size);
TEST_ASSERT_PIPE_HANDLE(pipe_hdl, p_hidh_kbd->pipe_hdl);
TEST_ASSERT_EQUAL(8, p_hidh_kbd->report_size);
TEST_ASSERT_EQUAL(sizeof(tusb_descriptor_interface_t) + sizeof(tusb_hid_descriptor_hid_t) + sizeof(tusb_descriptor_endpoint_t),
length);
tusbh_device_get_state_IgnoreAndReturn(TUSB_DEVICE_STATE_CONFIGURED);
TEST_ASSERT_EQUAL(2, tusbh_hid_keyboard_no_instances(dev_addr)); // init set instance number to 1
TEST_ASSERT_TRUE( tusbh_hid_keyboard_is_supported(dev_addr) );
}
void test_keyboard_close(void)
@ -150,12 +146,6 @@ void test_keyboard_get_invalid_address(void)
TEST_ASSERT_EQUAL(TUSB_ERROR_INVALID_PARA, tusbh_hid_keyboard_get(0, 0, NULL)); // invalid address
}
void test_keyboard_get_invalid_instance(void)
{
tusbh_device_get_state_IgnoreAndReturn(TUSB_DEVICE_STATE_CONFIGURED);
TEST_ASSERT_EQUAL(TUSB_ERROR_INVALID_PARA, tusbh_hid_keyboard_get(dev_addr, TUSB_CFG_HOST_HID_KEYBOARD_NO_INSTANCES_PER_DEVICE, &report)); // invalid instance
}
void test_keyboard_get_invalid_buffer(void)
{
tusbh_device_get_state_IgnoreAndReturn(TUSB_DEVICE_STATE_CONFIGURED);
@ -171,18 +161,18 @@ void test_keyboard_get_device_not_ready(void)
void test_keyboard_get_report_xfer_failed()
{
tusbh_device_get_state_IgnoreAndReturn(TUSB_DEVICE_STATE_CONFIGURED);
hcd_pipe_xfer_ExpectAndReturn(p_hidh_kbd_interface->pipe_in, (uint8_t*) &report, p_hidh_kbd_interface->report_size, true, TUSB_ERROR_INVALID_PARA);
hcd_pipe_xfer_ExpectAndReturn(p_hidh_kbd->pipe_hdl, (uint8_t*) &report, p_hidh_kbd->report_size, true, TUSB_ERROR_INVALID_PARA);
//------------- Code Under TEST -------------//
TEST_ASSERT_EQUAL(TUSB_ERROR_INVALID_PARA, tusbh_hid_keyboard_get(dev_addr, instance_num, &report));
TEST_ASSERT_EQUAL(TUSB_ERROR_INVALID_PARA, tusbh_hid_keyboard_get(dev_addr, 0, &report));
}
void test_keyboard_get_ok()
{
tusbh_device_get_state_IgnoreAndReturn(TUSB_DEVICE_STATE_CONFIGURED);
hcd_pipe_xfer_ExpectAndReturn(p_hidh_kbd_interface->pipe_in, (uint8_t*) &report, p_hidh_kbd_interface->report_size, true, TUSB_ERROR_NONE);
hcd_pipe_xfer_ExpectAndReturn(p_hidh_kbd->pipe_hdl, (uint8_t*) &report, p_hidh_kbd->report_size, true, TUSB_ERROR_NONE);
//------------- Code Under TEST -------------//
TEST_ASSERT_EQUAL(TUSB_ERROR_NONE, tusbh_hid_keyboard_get(dev_addr, instance_num, &report));
TEST_ASSERT_EQUAL(TUSB_ERROR_NONE, tusbh_hid_keyboard_get(dev_addr, 0, &report));
}

40
tinyusb/class/hid_host_keyboard.c
View File

@ -56,10 +56,10 @@
//--------------------------------------------------------------------+
STATIC_ hidh_keyboard_info_t keyboard_data[TUSB_CFG_HOST_DEVICE_MAX]; // does not have addr0, index = dev_address-1
static inline keyboard_interface_t* get_kbd_instance(uint8_t dev_addr, uint8_t instance_num) ATTR_PURE ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
static inline keyboard_interface_t* get_kbd_instance(uint8_t dev_addr, uint8_t instance_num)
static inline hidh_keyboard_info_t* get_kbd_data(uint8_t dev_addr) ATTR_PURE ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
static inline hidh_keyboard_info_t* get_kbd_data(uint8_t dev_addr)
{
return &keyboard_data[dev_addr-1].instance[instance_num];
return &keyboard_data[dev_addr-1];
}
//--------------------------------------------------------------------+
@ -69,28 +69,27 @@ static inline keyboard_interface_t* get_kbd_instance(uint8_t dev_addr, uint8_t i
//--------------------------------------------------------------------+
// PUBLIC API (parameter validation required)
//--------------------------------------------------------------------+
tusb_error_t tusbh_hid_keyboard_get(uint8_t const dev_addr, uint8_t instance_num, tusb_keyboard_report_t * const report)
bool tusbh_hid_keyboard_is_supported(uint8_t dev_addr)
{
return tusbh_device_is_configured(dev_addr) && pipehandle_is_valid(keyboard_data[dev_addr-1].pipe_hdl);
}
tusb_error_t tusbh_hid_keyboard_get(uint8_t dev_addr, uint8_t instance_num, tusb_keyboard_report_t * const report)
{
//------------- parameters validation -------------//
ASSERT_INT(TUSB_DEVICE_STATE_CONFIGURED, tusbh_device_get_state(dev_addr), TUSB_ERROR_DEVICE_NOT_READY);
ASSERT_PTR(report, TUSB_ERROR_INVALID_PARA);
ASSERT(instance_num < keyboard_data[dev_addr-1].instance_count, TUSB_ERROR_INVALID_PARA);
keyboard_interface_t *p_kbd = get_kbd_instance(dev_addr, instance_num);
(void) instance_num;
// TODO abtract to use hidh service
ASSERT_STATUS( hcd_pipe_xfer(p_kbd->pipe_in, (uint8_t*) report, p_kbd->report_size, true) ) ;
hidh_keyboard_info_t *p_keyboard = get_kbd_data(dev_addr);
// TODO abstract to use hidh service
ASSERT_STATUS( hcd_pipe_xfer(p_keyboard->pipe_hdl, (uint8_t*) report, p_keyboard->report_size, true) ) ;
return TUSB_ERROR_NONE;
}
uint8_t tusbh_hid_keyboard_no_instances(uint8_t const dev_addr)
{
ASSERT(tusbh_device_is_configured(dev_addr), 0);
return keyboard_data[dev_addr-1].instance_count;
}
//--------------------------------------------------------------------+
// INTERNAL API (no need for parameter validation)
//--------------------------------------------------------------------+
@ -101,7 +100,7 @@ void hidh_keyboard_init(void)
tusb_error_t hidh_keyboard_open_subtask(uint8_t dev_addr, uint8_t const *descriptor, uint16_t *p_length)
{
keyboard_interface_t *p_keyboard = get_kbd_instance(dev_addr, keyboard_data[dev_addr-1].instance_count);
hidh_keyboard_info_t *p_keyboard = get_kbd_data(dev_addr);
uint8_t const *p_desc = descriptor;
p_desc += p_desc[DESCRIPTOR_OFFSET_LENGTH]; // skip interface
@ -117,16 +116,13 @@ tusb_error_t hidh_keyboard_open_subtask(uint8_t dev_addr, uint8_t const *descrip
//------------- Endpoint Descriptor -------------//
ASSERT_INT(TUSB_DESC_ENDPOINT, p_desc[DESCRIPTOR_OFFSET_TYPE], TUSB_ERROR_INVALID_PARA);
p_keyboard->pipe_in = hcd_pipe_open(dev_addr, (tusb_descriptor_endpoint_t*) p_desc, TUSB_CLASS_HID);
p_keyboard->report_size = ( ((tusb_descriptor_endpoint_t*) p_desc)->wMaxPacketSize & (BIT_(12)-1) );
p_keyboard->pipe_hdl = hcd_pipe_open(dev_addr, (tusb_descriptor_endpoint_t*) p_desc, TUSB_CLASS_HID);
p_keyboard->report_size = ( ((tusb_descriptor_endpoint_t*) p_desc)->wMaxPacketSize & (BIT_(12)-1) );
p_desc += p_desc[DESCRIPTOR_OFFSET_LENGTH]; // advance endpoint descriptor
(*p_length) = p_desc - descriptor;
ASSERT (pipehandle_is_valid(p_keyboard->pipe_in), TUSB_ERROR_HCD_FAILED);
keyboard_data[dev_addr-1].instance_count++;
ASSERT (pipehandle_is_valid(p_keyboard->pipe_hdl), TUSB_ERROR_HCD_FAILED);
return TUSB_ERROR_NONE;
}

21
tinyusb/class/hid_host_keyboard.h
View File

@ -62,15 +62,9 @@
//--------------------------------------------------------------------+
// PUBLIC API (parameter validation required)
//--------------------------------------------------------------------+
uint8_t tusbh_hid_keyboard_no_instances(uint8_t const dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
static inline bool tusbh_hid_keyboard_is_supported(uint8_t const dev_addr) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_PURE;
static inline bool tusbh_hid_keyboard_is_supported(uint8_t const dev_addr)
{
return tusbh_hid_keyboard_no_instances(dev_addr) > 0;
}
tusb_error_t tusbh_hid_keyboard_get(uint8_t const dev_addr, uint8_t const instance_num, tusb_keyboard_report_t * const report) ATTR_WARN_UNUSED_RESULT;
pipe_status_t tusbh_hid_keyboard_pipe_status(uint8_t const dev_addr, uint8_t const instance_num) ATTR_WARN_UNUSED_RESULT;
bool tusbh_hid_keyboard_is_supported(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
tusb_error_t tusbh_hid_keyboard_get(uint8_t dev_addr, uint8_t instance_num, tusb_keyboard_report_t * const report) ATTR_WARN_UNUSED_RESULT;
pipe_status_t tusbh_hid_keyboard_pipe_status(uint8_t dev_addr, uint8_t instance_num) ATTR_WARN_UNUSED_RESULT;
//--------------------------------------------------------------------+
// INTERNAL API (no need for parameter validation)
@ -78,14 +72,9 @@ pipe_status_t tusbh_hid_keyboard_pipe_status(uint8_t const dev_addr, uint8_t con
#ifdef _TINY_USB_SOURCE_FILE_
typedef struct {
pipe_handle_t pipe_in;
pipe_handle_t pipe_hdl;
uint16_t report_size;
}keyboard_interface_t;
typedef struct {
uint8_t instance_count;
keyboard_interface_t instance[TUSB_CFG_HOST_HID_KEYBOARD_NO_INSTANCES_PER_DEVICE];
} hidh_keyboard_info_t;
}hidh_keyboard_info_t;
void hidh_keyboard_init(void);
tusb_error_t hidh_keyboard_open_subtask(uint8_t dev_addr, uint8_t const *descriptor, uint16_t *p_length) ATTR_WARN_UNUSED_RESULT;

8
tinyusb/tusb_option.h
View File

@ -125,13 +125,9 @@
//------------- HID CLASS -------------//
#define HOST_CLASS_HID ( TUSB_CFG_HOST_HID_KEYBOARD )
#if TUSB_CFG_HOST_HID_KEYBOARD
#if !defined(TUSB_CFG_HOST_HID_KEYBOARD_NO_INSTANCES_PER_DEVICE)
#define TUSB_CFG_HOST_HID_KEYBOARD_NO_INSTANCES_PER_DEVICE 1
#endif
#if HOST_CLASS_HID
#define HOST_HCD_XFER_INTERRUPT
#endif // end TUSB_CFG_HOST_HID_KEYBOARD
#endif
#ifndef TUSB_CFG_HOST_ENUM_BUFFER_SIZE
#define TUSB_CFG_HOST_ENUM_BUFFER_SIZE 256