Capture.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016, 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.
 */
#ifndef ti_drivers_Capture__include
#define ti_drivers_Capture__include

#ifdef __cplusplus
extern "C"
{
#endif

#include <stdint.h>
#include <stdbool.h>

typedef struct Capture_Config_ *Capture_Handle;

#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 enum Capture_Period_Unit_ {
    CAPTURE_PERIOD_US,      /* Period in microseconds */
    CAPTURE_PERIOD_HZ,      /* Period in frequency */
    CAPTURE_PERIOD_COUNTS,  /* Period in counts */
} Capture_Period_Unit;

typedef enum Capture_Mode_ {
    CAPTURE_MODE_RISING_RISING, 
    CAPTURE_MODE_FALLING_FALLING, 
    CAPTURE_MODE_ANY_EDGE
} Capture_Mode;

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

typedef struct Capture_Params_ {
    Capture_Mode mode; 
    Capture_CallBackFxn callbackFxn; 
    Capture_Period_Unit 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 void (*Capture_StartFxn)(Capture_Handle handle);

typedef void (*Capture_StopFxn)(Capture_Handle handle);

typedef struct Capture_FxnTable_ {
    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 void Capture_start(Capture_Handle handle);

extern void Capture_stop(Capture_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_Capture__include */