reform

MNT Reform: Open Source Portable Computer
Log (Feed) | Files | Refs (Tags) | README

Descriptors.h (3454B)

      1 /*
      2   LUFA Library
      3   Copyright (C) Dean Camera, 2018.
      4 
      5   dean [at] fourwalledcubicle [dot] com
      6   www.lufa-lib.org
      7 */
      8 
      9 /*
     10   Copyright 2018  Dean Camera (dean [at] fourwalledcubicle [dot] com)
     11 
     12   Permission to use, copy, modify, distribute, and sell this
     13   software and its documentation for any purpose is hereby granted
     14   without fee, provided that the above copyright notice appear in
     15   all copies and that both that the copyright notice and this
     16   permission notice and warranty disclaimer appear in supporting
     17   documentation, and that the name of the author not be used in
     18   advertising or publicity pertaining to distribution of the
     19   software without specific, written prior permission.
     20 
     21   The author disclaims all warranties with regard to this
     22   software, including all implied warranties of merchantability
     23   and fitness.  In no event shall the author be liable for any
     24   special, indirect or consequential damages or any damages
     25   whatsoever resulting from loss of use, data or profits, whether
     26   in an action of contract, negligence or other tortious action,
     27   arising out of or in connection with the use or performance of
     28   this software.
     29 */
     30 
     31 /** \file
     32  *
     33  *  Header file for Descriptors.c.
     34  */
     35 
     36 #ifndef _DESCRIPTORS_H_
     37 #define _DESCRIPTORS_H_
     38 
     39 /* Includes: */
     40 #include <LUFA/Drivers/USB/USB.h>
     41 
     42 #include <avr/pgmspace.h>
     43 
     44 /* Macros: */
     45 /** Endpoint address of the Mouse HID reporting IN endpoint. */
     46 #define MOUSE_EPADDR              (ENDPOINT_DIR_IN | 1)
     47 
     48 /** Size in bytes of the Mouse HID reporting IN endpoint. */
     49 #define MOUSE_EPSIZE              8
     50 
     51 /* Type Defines: */
     52 /** Type define for the device configuration descriptor structure. This must be defined in the
     53  *  application code, as the configuration descriptor contains several sub-descriptors which
     54  *  vary between devices, and which describe the device's usage to the host.
     55  */
     56 typedef struct
     57 {
     58   USB_Descriptor_Configuration_Header_t Config;
     59 
     60   // Mouse HID Interface
     61   USB_Descriptor_Interface_t            HID_Interface;
     62   USB_HID_Descriptor_HID_t              HID_MouseHID;
     63   USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
     64 } USB_Descriptor_Configuration_t;
     65 
     66 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
     67  *  should have a unique ID index associated with it, which can be used to refer to the
     68  *  interface from other descriptors.
     69  */
     70 enum InterfaceDescriptors_t
     71   {
     72     INTERFACE_ID_Mouse = 0, /**< Mouse interface descriptor ID */
     73   };
     74 
     75 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
     76  *  have a unique ID index associated with it, which can be used to refer to the string from
     77  *  other descriptors.
     78  */
     79 enum StringDescriptors_t
     80   {
     81     STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
     82     STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
     83     STRING_ID_Product      = 2, /**< Product string ID */
     84   };
     85 
     86 /* Function Prototypes: */
     87 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
     88                                     const uint16_t wIndex,
     89                                     const void** const DescriptorAddress)
     90   ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
     91 
     92 typedef struct
     93 {
     94   uint8_t Button;
     95   int8_t  X;
     96   int8_t  Y;
     97   int8_t  Wheel;
     98   int8_t  Pan;
     99 } ATTR_PACKED USB_WheelMouseReport_Data_t;
    100 
    101 typedef struct
    102 {
    103   int8_t Multiplier;
    104 } ATTR_PACKED USB_WheelMouseFeatureReport_Data_t;
    105 
    106 #endif