ClockP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, 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_osal_ClockP__include
#define ti_osal_ClockP__include

#ifdef __cplusplus
extern "C" {
#endif

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

typedef enum ClockP_Status_e
{
    ClockP_OK         = 0,
    ClockP_FAILURE    = (-(int32_t)1)
} ClockP_Status;

typedef uint8_t ClockP_RunMode;
#define ClockP_RunMode_ONESHOT                      ((uint8_t) 0U)

#define ClockP_RunMode_CONTINUOUS                   ((uint8_t) 1U)
/* @} */

typedef uint8_t ClockP_StartMode;
 #define ClockP_StartMode_USER                      ((uint8_t) 0U)

#define ClockP_StartMode_AUTO                       ((uint8_t) 1U)
/* @} */

typedef  void *ClockP_Handle;

typedef struct ClockP_Params_s
{
    void     *pErrBlk;   
    uint8_t  startMode;  
    uint32_t period;     
    uint8_t  runMode;    
    void     *arg;       
} ClockP_Params;

extern void ClockP_Params_init(ClockP_Params *params);

typedef void (*ClockP_FxnCallback)(void *args);

extern ClockP_Handle ClockP_create(ClockP_FxnCallback clockfxn,
                                   const ClockP_Params *params);

extern ClockP_Status ClockP_delete(ClockP_Handle handle);

extern ClockP_Status ClockP_start(ClockP_Handle handle);

extern ClockP_Status ClockP_stop(ClockP_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_osal_ClockP__include */
/* @} */