ClockP.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2023 Texas Instruments Incorporated
 *
 *  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 CLOCKP_H
#define CLOCKP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
 
#if defined (OS_SAFERTOS)
#define ClockP_OBJECT_SIZE_MAX    (120u)
#else
#define ClockP_OBJECT_SIZE_MAX    (104u)
#endif
 
typedef struct ClockP_Object_ {
 
    /* uintptr_t translates to uint64_t for A53 and uint32_t for R5 and M4 */
    /* This accounts for the 64bit pointer in A53 and 32bit pointer in R5 and M4 */
    uintptr_t rsv[ClockP_OBJECT_SIZE_MAX/sizeof(uint32_t)]; 
} ClockP_Object;
 
 
typedef struct ClockP_Config_
{
    uint32_t timerBaseAddr; 
    uint32_t timerHwiIntNum; 
    uint32_t timerInputClkHz; 
    uint32_t timerInputPreScaler; 
    uint32_t usecPerTick; 
    uint8_t  intrPriority; 
} ClockP_Config;
 
typedef void (*ClockP_FxnCallback)(ClockP_Object *obj, void *args);
 
typedef struct ClockP_Params_ {
 
    uint32_t start; 
    uint32_t timeout; 
    uint32_t period; 
    ClockP_FxnCallback callback; 
    void *args; 
  const char *name; 
} ClockP_Params;
 
 
 
void ClockP_init(void);
 
void ClockP_Params_init(ClockP_Params *params);
 
int32_t ClockP_construct(ClockP_Object *obj, ClockP_Params *params);
 
void ClockP_destruct(ClockP_Object *obj);
 
void ClockP_start(ClockP_Object *obj);
 
void ClockP_stop(ClockP_Object *obj);
 
uint32_t ClockP_isActive(ClockP_Object *obj);
 
void ClockP_setTimeout(ClockP_Object *obj, uint32_t timeout);
 
uint32_t ClockP_getTimeout(ClockP_Object *obj);
 
uint32_t ClockP_getTicks(void);
 
uint32_t ClockP_usecToTicks(uint64_t usecs);
 
uint64_t ClockP_ticksToUsec(uint32_t ticks);
 
 
uint64_t ClockP_getTimeUsec(void);
 
void ClockP_usleep(uint32_t usec);
 
void ClockP_sleep(uint32_t sec);
 
#ifdef __cplusplus
}
#endif
 
#endif /* CLOCKP_H */