usbdhidsensor.h

Go to the documentation of this file.

//*****************************************************************************
//
// usbdhidsensor.h - Definitions used by HID sensor class devices.
//
// Copyright (c) 2008-2017 Texas Instruments Incorporated.  All rights reserved.
// Software License Agreement
//
// Texas Instruments (TI) is supplying this software for use solely and
// exclusively on TI's microcontroller products. The software is owned by
// TI and/or its suppliers, and is protected under applicable copyright
// laws. You may not combine this software with "viral" open-source
// software in order to form a larger program.
//
// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
// DAMAGES, FOR ANY REASON WHATSOEVER.
//
//
//*****************************************************************************
#ifndef __USBDHIDSENSOR_H__
#define __USBDHIDSENSOR_H__

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif

//*****************************************************************************
//
//
//*****************************************************************************
//*****************************************************************************
//
// PRIVATE
//
// The first few sections of this header are private defines that are used by
// the USB HID sensor code and are here only to help with the application
// allocating the correct amount of memory for the USB HID Sensor device
// code.
//
//*****************************************************************************


//*****************************************************************************
//
// PRIVATE
//
// This enumeration holds the various states that the sensor can be in during
// normal operation.
//
//*****************************************************************************
typedef enum
{
    //
    // Not yet configured.
    //
    eHIDSensorStateNotConnected,

    //
    // Nothing to transmit and not waiting on data to be sent.
    //
    eHIDSensorStateIdle,

    //
    // Waiting on data to be sent.
    //
    eHIDSensorStateSending
}
tSensorState;


//*****************************************************************************
//
// PRIVATE
//
// This structure defines the private instance data structure for the USB HID
// sensor device.  This structure forms the RAM workspace used by each
// instance of the sensor.
//
//*****************************************************************************
typedef struct
{
    //
    // This is needed for the lower level HID driver.
    //
    tUSBDHIDDevice sHIDDevice;

     //
    // The current state of the game pad device.
    //
    tSensorState iState;

    //
    // The idle timeout control structure for our input report.  This is
    // required by the lower level HID driver.
    //
    tHIDReportIdle sReportIdle;
} tUSBDSensorInstance;

//*****************************************************************************
//
//
//*****************************************************************************
typedef struct
{
    //
    //
    const uint16_t ui16VID;

    //
    //
    const uint16_t ui16PID;

    //
    //
    const uint16_t ui16MaxPowermA;

    //
    //
    const uint8_t ui8PwrAttributes;

    //
    const tUSBCallback pfnCallback;

    //
    //
    void *pvCBData;

    //
    //
    const uint8_t * const *ppui8StringDescriptors;

    //
    //
    const uint32_t ui32NumStringDescriptors;

    //
    //
    tUSBDSensorInstance sPrivateData;
}
tUSBDHIDSensorDevice;

//
//
//*****************************************************************************
#define USBDSENSOR_SUCCESS     0

//*****************************************************************************
//
//
//*****************************************************************************
#define USBDSENSOR_TX_ERROR    1

//*****************************************************************************
//
//
//*****************************************************************************
#define USBDSENSOR_NOT_CONFIGURED    2


//*****************************************************************************
//
//
//*****************************************************************************
typedef struct
{

    //
    //
    uint8_t ui8SensorState;

    //
    //
    uint8_t ui8SensorEvent;

    //
    //
    int16_t i16Temp;

}PACKED tSensorTemperatureReport;


//*****************************************************************************
//
// API Function Prototypes
//
//*****************************************************************************
extern tUSBDHIDSensorDevice *USBDHIDSensorInit(uint32_t ui32Index,
                                        tUSBDHIDSensorDevice *psHIDSensor);
extern tUSBDHIDSensorDevice *USBDHIDSensorCompositeInit(uint32_t ui32Index,
                                         tUSBDHIDSensorDevice *psHIDSensor,
                                         tCompositeEntry *psCompEntry);
extern void USBDHIDSensorTerm(tUSBDHIDSensorDevice *psCompEntry);

extern uint32_t USBDHIDSensorSendReport(tUSBDHIDSensorDevice *psHIDSensor,
                                         void *pvReport, uint32_t ui32Size);

//*****************************************************************************
//
// Close the Doxygen group.
//
//*****************************************************************************



//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

#endif // __USBDHIDSENSOR_H__