Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 disclaim 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 ConfigDescriptor.c.
  34  */
  35
  36 #ifndef _CONFIGDESCRIPTOR_H_
  37 #define _CONFIGDESCRIPTOR_H_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>
  41
  42                 #include "MouseHost.h"
  43
  44         /* Macros: */
  45                 /** Interface Class value for the Human Interface Device class. */
  46                 #define MOUSE_CLASS                 0x03
  47
  48                 /** Interface Protocol value for a Boot Protocol Mouse compliant device. */
  49                 #define MOUSE_PROTOCOL              0x02
  50
  51                 /** Pipe number for the mouse data IN pipe. */
  52                 #define MOUSE_DATA_IN_PIPE          1
  53
  54         /* Enums: */
  55                 /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
  56                 enum MouseHost_GetConfigDescriptorDataCodes_t
  57                 {
  58                         SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */
  59                         ControlError                    = 1, /**< A control request to the device failed to complete successfully */
  60                         DescriptorTooLarge              = 2, /**< The device's Configuration Descriptor is too large to process */
  61                         InvalidConfigDataReturned       = 3, /**< The device returned an invalid Configuration Descriptor */
  62                         NoCompatibleInterfaceFound      = 4, /**< A compatible interface with the required endpoints was not found */
  63                 };
  64
  65         /* Function Prototypes: */
  66                 uint8_t ProcessConfigurationDescriptor(void);
  67
  68                 uint8_t DComp_NextMouseInterface(void* CurrentDescriptor);
  69                 uint8_t DComp_NextMouseInterfaceDataEndpoint(void* CurrentDescriptor);
  70
  71 #endif