ClockP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2023, 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_dpl_ClockP__include
#define ti_dpl_ClockP__include

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

#ifdef __cplusplus
extern "C" {
#endif

#define ClockP_STRUCT_SIZE (68)

typedef union ClockP_Struct
{
    uint32_t dummy; 
    uint8_t data[ClockP_STRUCT_SIZE];
} ClockP_Struct;

typedef struct
{
    uint32_t hi; 
    uint32_t lo; 
} ClockP_FreqHz;

typedef enum
{
    ClockP_OK      = 0,
    ClockP_FAILURE = -1
} ClockP_Status;

typedef void *ClockP_Handle;

#define ClockP_handle(x) ((ClockP_Handle)(x))

typedef void (*ClockP_Fxn)(uintptr_t arg);

typedef struct
{
    bool startFlag;  
    uint32_t period; 
    uintptr_t arg;   
} ClockP_Params;

extern ClockP_Handle ClockP_construct(ClockP_Struct *clockP,
                                      ClockP_Fxn clockFxn,
                                      uint32_t timeout,
                                      ClockP_Params *params);

extern void ClockP_destruct(ClockP_Struct *clockP);

extern ClockP_Handle ClockP_create(ClockP_Fxn clockFxn, uint32_t timeout, ClockP_Params *params);

extern void ClockP_delete(ClockP_Handle handle);

extern void ClockP_getCpuFreq(ClockP_FreqHz *freq);

extern uint32_t ClockP_getSystemTickPeriod(void);

extern uint32_t ClockP_getSystemTicks(void);

extern uint32_t ClockP_getTicksUntilInterrupt(void);

extern uint32_t ClockP_getTimeout(ClockP_Handle handle);

extern bool ClockP_isActive(ClockP_Handle handle);

extern void ClockP_Params_init(ClockP_Params *params);

extern void ClockP_setTimeout(ClockP_Handle handle, uint32_t timeout);

extern void ClockP_setPeriod(ClockP_Handle handle, uint32_t period);

extern void ClockP_start(ClockP_Handle handle);

extern void ClockP_stop(ClockP_Handle handle);

extern void ClockP_usleep(uint32_t usec);

extern void ClockP_sleep(uint32_t sec);

#ifdef __cplusplus
}
#endif

#endif /* ti_dpl_ClockP__include */