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

Go to the source code of this file.

Data Structures

struct  RTC_State_t
 A structure to represent RTC device state. More...
 
struct  RTC_Device_Type
 A structure to represent RTC device. More...
 

Typedefs

typedef const struct RTC_Device_Type RTC_Device_t
 
typedef void(* rtc_cb_func_t) (RTC_Device_t *dev)
 

Enumerations

enum  { RTC_MODE_NONE, RTC_MODE_RISING_EDGE, RTC_MODE_FALLING_EDGE }
 

Functions

RTC_Device_tRTC_devRequest (void)
 Request A RTC Device. More...
 
int32_t RTC_devInit (RTC_Device_t *dev, uint8_t mode, uint8_t div, void *cb)
 Initialize RTC 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(* rtc_cb_func_t) (RTC_Device_t *dev)
typedef const struct RTC_Device_Type RTC_Device_t

Enumeration Type Documentation

anonymous enum
Enumerator
RTC_MODE_NONE 
RTC_MODE_RISING_EDGE 
RTC_MODE_FALLING_EDGE 

Function Documentation

int32_t RTC_devInit ( RTC_Device_t dev,
uint8_t  mode,
uint8_t  div,
void *  cb 
)

Initialize RTC Timer.

Parameters
devThe pointer to RTC device,
modeThe enumeration of rtc timer mode.
divThe enumeration of rtc clock divider.
cbThe pointer to the call back function for rising or falling edge.
Returns
0 for success or error code upon a failure.
RTC_Device_t* RTC_devRequest ( void  )

Request A RTC Device.

Returns
The pointer to the RTC device instance.

Request A RTC Device.