Capture.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*!*****************************************************************************
 *  @file       Capture.h
 *  @brief      Capture Driver
 *
 *  @anchor ti_drivers_Capture_Overview
 *  # Overview
 *
 *  The capture driver is used to detect and time edge triggered events on a
 *  GPIO pin.
 *
 *  The capture driver serves as the main interface for a typical RTOS
 *  application. Its purpose is to redirect the capture APIs to device specific
 *  implementations which are specified using a pointer to a #Capture_FxnTable.
 *  The device specific implementations are responsible for creating all the
 *  RTOS specific primitives to allow for thead-safe operation. The capture
 *  driver utilizes the general purpose timer hardware.
 *
 *  The capture driver internally handles the general purpose timer resource
 *  allocation. For each capture driver instance, Capture_open() occupies the
 *  specified timer, and Capture_close() releases the occupied timer resource.
 *
 *  <hr>
 *  @anchor ti_drivers_Capture_Usage
 *  # Usage
 *
 *  This documentation provides a basic @ref ti_drivers_Capture_Synopsis
 *  "usage summary" and a set of @ref ti_drivers_Capture_Examples "examples"
 *  in the form of commented code fragments. Detailed descriptions of the
 *  APIs are provided in subsequent sections.
 *
 *  @anchor ti_drivers_Capture_Synopsis
 *  ## Synopsis
 *  @anchor ti_drivers_Capture_Synopsis_Code
 *  @code
 *  // Import Capture Driver definitions
 *  #include <ti/drivers/Capture.h>
 *
 *  Capture_Handle    handle;
 *  Capture_Params    params;
 *
 *  Capture_Params_init(&params);
 *  params.mode  = Capture_FALLING_EDGE;
 *  params.callbackFxn = someCaptureCallbackFunction;
 *  params.periodUnit = Capture_PERIOD_US;
 *
 *  handle = Capture_open(CONFIG_CAPTURE0, &params);
 *
 *  if (handle == NULL) {
 *      //Capture_open() failed
 *      while(1);
 *  }
 *
 *  status = Capture_start(handle);
 *
 *  if (status == Capture_STATUS_ERROR) {
 *      //Capture_start() failed
 *      while(1);
 *  }
 *
 *  sleep(10000);
 *
 *  Capture_stop(handle);
 *  @endcode
 *
 *  <hr>
 *  @anchor ti_drivers_Capture_Examples
 *  # Examples
 *
 *  @li @ref ti_drivers_Capture_Examples_open "Opening a Capture instance"
 *
 *  @anchor ti_drivers_Capture_Examples_open
 *  ## Opening a Capture instance
 *
 *  @code
 *  Capture_Handle  handle;
 *  Capture_Params  params;
 *
 *  Capture_Params_init(&params);
 *  params.mode  = Capture_FALLING_EDGE;
 *  params.callbackFxn = someCaptureCallbackFunction;
 *  params.periodUnit = Capture_PERIOD_US;
 *
 *  handle = Capture_open(CONFIG_CAPTURE0, &params);
 *
 *  if (handle == NULL) {
 *      //Capture_open() failed
 *      while(1);
 *  }
 *  @endcode
 *
 *  <hr>
 *  @anchor ti_drivers_Capture_Configuration
 *  # Configuration
 *
 *  Refer to the @ref driver_configuration "Driver's Configuration" section
 *  for driver configuration information.
 *  <hr>
 *******************************************************************************
 */

#ifndef ti_drivers_Capture__include
#define ti_drivers_Capture__include

#include <stdint.h>

#ifdef __cplusplus
extern "C"
{
#endif

#define Capture_CMD_RESERVED             (32)

#define Capture_STATUS_RESERVED         (-32)

#define Capture_STATUS_SUCCESS          (0)

#define Capture_STATUS_ERROR            (-1)

#define Capture_STATUS_UNDEFINEDCMD    (-2)

typedef struct Capture_Config_ *Capture_Handle;


typedef enum {
    Capture_RISING_EDGE,     
    Capture_FALLING_EDGE,    
    Capture_ANY_EDGE,         
    Capture_RISING_EDGE_FALLING_EDGE,  
    Capture_FALLING_EDGE_RISING_EDGE,  
} Capture_Mode;

typedef enum {
    Capture_PERIOD_US,       
    Capture_PERIOD_HZ,       
    Capture_PERIOD_COUNTS,    
    Capture_PERIOD_NS,       
} Capture_PeriodUnits;


typedef void (*Capture_CallBackFxn)(Capture_Handle handle, uint32_t interval);

typedef struct {
    Capture_Mode           mode;

    Capture_CallBackFxn    callbackFxn;

    Capture_PeriodUnits    periodUnit;
} Capture_Params;

typedef void (*Capture_CloseFxn)(Capture_Handle handle);

typedef int_fast16_t (*Capture_ControlFxn)(Capture_Handle handle,
    uint_fast16_t cmd, void *arg);

typedef void (*Capture_InitFxn)(Capture_Handle handle);

typedef Capture_Handle (*Capture_OpenFxn)(Capture_Handle handle,
    Capture_Params *params);

typedef int32_t (*Capture_StartFxn)(Capture_Handle handle);

typedef void (*Capture_StopFxn)(Capture_Handle handle);

typedef struct {
    Capture_CloseFxn closeFxn;

    Capture_ControlFxn controlFxn;

    Capture_InitFxn initFxn;

    Capture_OpenFxn openFxn;

    Capture_StartFxn startFxn;

    Capture_StopFxn stopFxn;
} Capture_FxnTable;

typedef struct Capture_Config_ {
    Capture_FxnTable const *fxnTablePtr;

    void                   *object;

    void             const *hwAttrs;
} Capture_Config;

extern void Capture_close(Capture_Handle handle);

extern int_fast16_t Capture_control(Capture_Handle handle, uint_fast16_t cmd,
    void *arg);

extern void Capture_init(void);

extern Capture_Handle Capture_open(uint_least8_t index, Capture_Params *params);

extern void Capture_Params_init(Capture_Params *params);

extern int32_t Capture_start(Capture_Handle handle);

extern void Capture_stop(Capture_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_Capture__include */