circuitpython/ports/nrf/common-hal/usb_hid/Device.h

95 lines
2.7 KiB
C

/*
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2018 hathach for Adafruit Industries
*
* 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 COMMON_HAL_USB_HID_DEVICE_H
#define COMMON_HAL_USB_HID_DEVICE_H
#include <stdint.h>
#include <stdbool.h>
#include "py/obj.h"
#ifdef __cplusplus
extern "C" {
#endif
// 1 to enable device, 0 to disable
#define USB_HID_DEVICE_KEYBOARD 1
#define USB_HID_DEVICE_MOUSE 1
#define USB_HID_DEVICE_CONSUMER 1
#define USB_HID_DEVICE_SYS_CONTROL 1
#define USB_HID_DEVICE_GAMEPAD 1
#define USB_HID_DEVICE_DIGITIZER 0 // not supported yet
enum {
USB_HID_REPORT_ID_UNUSED = 0,
#if USB_HID_DEVICE_KEYBOARD
USB_HID_REPORT_ID_KEYBOARD,
#endif
#if USB_HID_DEVICE_MOUSE
USB_HID_REPORT_ID_MOUSE,
#endif
#if USB_HID_DEVICE_CONSUMER
USB_HID_REPORT_ID_CONSUMER,
#endif
#if USB_HID_DEVICE_SYS_CONTROL
USB_HID_REPORT_ID_SYS_CONTROL,
#endif
#if USB_HID_DEVICE_GAMEPAD
USB_HID_REPORT_ID_GAMEPAD,
#endif
#if USB_HID_DEVICE_DIGITIZER
USB_HID_REPORT_ID_DIGITIZER,
#endif
};
#define USB_HID_NUM_DEVICES (USB_HID_DEVICE_KEYBOARD + USB_HID_DEVICE_MOUSE + USB_HID_DEVICE_CONSUMER + \
USB_HID_DEVICE_SYS_CONTROL + USB_HID_DEVICE_GAMEPAD + USB_HID_DEVICE_DIGITIZER )
typedef struct {
mp_obj_base_t base;
uint8_t* report_buffer;
uint8_t report_id;
uint8_t report_length;
uint8_t usage_page;
uint8_t usage;
} usb_hid_device_obj_t;
extern usb_hid_device_obj_t usb_hid_devices[];
#ifdef __cplusplus
}
#endif
#endif /* COMMON_HAL_USB_HID_DEVICE_H */