Kamcho Library 02.00.03  lib.kamcho.02.00.03.287
Data Structures | Typedefs | Enumerations | Functions
systick_device.h File Reference
#include <stdint.h>
#include "hdf.h"
#include "errno.h"

Go to the source code of this file.

Data Structures

struct  SysTick_Device_t
 A structure to represent WDT device. More...
 

Typedefs

typedef void(* systick_cb_func_t) (SysTick_Device_t *dev)
 The SysTick timer interrupt call back function. More...
 

Enumerations

enum  { SYSTICK_MODE_DISABLE, SYSTICK_MODE_ENABLE, SYSTICK_MODE_ENABLE_INTERRUPT }
 

Functions

SysTick_Device_tSysTick_devRequest (void)
 Request a SysTick Device. More...
 
int32_t SysTick_devDelayTicks (SysTick_Device_t *dev, uint32_t ticks)
 SysTick time delay in tick. More...
 
int32_t SysTick_devDelayMs (SysTick_Device_t *dev, uint32_t ms)
 SysTick time delay in ms. More...
 
int32_t SysTick_devGetInterruptCounts (SysTick_Device_t *dev)
 Get Systick interrupt counts. More...
 
int64_t SysTick_devGetElapsedMs (SysTick_Device_t *dev)
 Get elapsed time in ms since last systick initialization. More...
 
int32_t SysTick_devInit (SysTick_Device_t *dev, uint8_t mode, uint32_t ticks, void *cb)
 Initialize SysTick Timer. More...
 

Detailed Description

This file is proprietary to Indie Semiconductor. All rights reserved. Reproduction or distribution, in whole or in part, is forbidden except by express written permission of Indie Semiconductor.

Typedef Documentation

typedef void(* systick_cb_func_t) (SysTick_Device_t *dev)

The SysTick timer interrupt call back function.

Enumeration Type Documentation

anonymous enum
Enumerator
SYSTICK_MODE_DISABLE 
SYSTICK_MODE_ENABLE 
SYSTICK_MODE_ENABLE_INTERRUPT 

Function Documentation

int32_t SysTick_devDelayMs ( SysTick_Device_t dev,
uint32_t  ms 
)

SysTick time delay in ms.

Parameters
devThe pointer to SysTick device,
msThe time delay in ms.
Returns
0 for success or error code upon a failure.
int32_t SysTick_devDelayTicks ( SysTick_Device_t dev,
uint32_t  ticks 
)

SysTick time delay in tick.

Parameters
devThe pointer to SysTick device,
ticksThe time delay in ticks.
Returns
0 for success or error code upon a failure.
int64_t SysTick_devGetElapsedMs ( SysTick_Device_t dev)

Get elapsed time in ms since last systick initialization.

Parameters
devThe pointer to SysTick device,
Returns
The elapsed time in ms for success or error code upon a failure.
int32_t SysTick_devGetInterruptCounts ( SysTick_Device_t dev)

Get Systick interrupt counts.

Parameters
devThe pointer to SysTick device,
Returns
The interrupt counts for success or error code upon a failure.
int32_t SysTick_devInit ( SysTick_Device_t dev,
uint8_t  mode,
uint32_t  ticks,
void *  cb 
)

Initialize SysTick Timer.

Parameters
devThe pointer to SysTick device,
modeThe enumeration of SysTick timer mode.
ticksThe reload counter settings.
cbThe pointer to the call back function if it is set to interrupt mode.
Returns
0 for success or error code upon a failure.
SysTick_Device_t* SysTick_devRequest ( void  )

Request a SysTick Device.

Returns
The pointer to the timer device instance.