lib/lufa/Projects/MediaController/MediaController.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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 MediaControl.c.
  34  */
  35
  36 #ifndef _MEDIACONTROL_H_
  37 #define _MEDIACONTROL_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/power.h>
  43                 #include <avr/interrupt.h>
  44                 #include <stdbool.h>
  45                 #include <string.h>
  46
  47                 #include "Descriptors.h"
  48
  49                 #include <LUFA/Drivers/Board/Joystick.h>
  50                 #include <LUFA/Drivers/Board/LEDs.h>
  51                 #include <LUFA/Drivers/Board/Buttons.h>
  52                 #include <LUFA/Drivers/USB/USB.h>
  53                 #include <LUFA/Platform/Platform.h>
  54
  55         /* Macros: */
  56                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  57                 #define LEDMASK_USB_NOTREADY      LEDS_LED1
  58
  59                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  60                 #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
  61
  62                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  63                 #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
  64
  65                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  66                 #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
  67
  68         /* Type Defines: */
  69                 /** Type define for a Media Control HID report. This report contains the bits to match the usages defined
  70                  *  in the HID report of the device. When set to a true value, the relevant media controls on the host will
  71                  *  be triggered.
  72                  */
  73                 typedef struct
  74                 {
  75                         unsigned Play           : 1;
  76                         unsigned Pause          : 1;
  77                         unsigned FForward       : 1;
  78                         unsigned Rewind         : 1;
  79                         unsigned NextTrack      : 1;
  80                         unsigned PreviousTrack  : 1;
  81                         unsigned Stop           : 1;
  82                         unsigned PlayPause      : 1;
  83                         unsigned Mute           : 1;
  84                         unsigned VolumeUp       : 1;
  85                         unsigned VolumeDown     : 1;
  86                         unsigned RESERVED       : 5;
  87                 } ATTR_PACKED USB_MediaReport_Data_t;
  88
  89         /* Function Prototypes: */
  90                 void SetupHardware(void);
  91
  92                 void EVENT_USB_Device_Connect(void);
  93                 void EVENT_USB_Device_Disconnect(void);
  94                 void EVENT_USB_Device_ConfigurationChanged(void);
  95                 void EVENT_USB_Device_ControlRequest(void);
  96                 void EVENT_USB_Device_StartOfFrame(void);
  97
  98                 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
  99                                                          uint8_t* const ReportID,
 100                                                          const uint8_t ReportType,
 101                                                          void* ReportData,
 102                                                          uint16_t* const ReportSize);
 103                 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 104                                                           const uint8_t ReportID,
 105                                                           const uint8_t ReportType,
 106                                                           const void* ReportData,
 107                                                           const uint16_t ReportSize);
 108
 109 #endif
 110