m2mb_rtc.h File Reference

m2m base api for rtc functionalities More...

Go to the source code of this file.

Data Structures
struct	M2MB_RTC_TIME_T
struct	M2MB_RTC_TIMEVAL_T

Enumerations
enum	M2MB_RTC_IOCTL_REQUEST_E {   M2MB_RTC_IOCTL_GET_SYSTEM_TIME, M2MB_RTC_IOCTL_SET_SYSTEM_TIME, M2MB_RTC_IOCTL_SET_ALARM_TIME, M2MB_RTC_IOCTL_CLEAR_ALARM,   M2MB_RTC_IOCTL_GET_TIMEVAL, M2MB_RTC_IOCTL_SET_TIMEVAL }

Functions
INT32	m2mb_rtc_open (const CHAR *path, INT32 flags,...)
	Open a RTC device. More...
INT32	m2mb_rtc_close (INT32 fd)
	Close a RTC device. More...
INT32	m2mb_rtc_ioctl (INT32 fd, INT32 request,...)
	Configure a RTC device. More...

Detailed Description

m2m base api for rtc functionalities

m2m/m2m_generic/common/m2mb_inc/m2mb_rtc.h

m2m base rtc api prototype: m2mb_rtc_open m2mb_rtc_close m2mb_rtc_ioctl

@notes

Author

Davide Cubeddu

Date

21/09/2017

Function Documentation

m2mb_rtc_close()

INT32 m2mb_rtc_close

(

INT32

fd

)

Close a RTC device.

Parameters

[in]

fd

file descriptor returned by m2mb_rtc_open

Returns

0 on SUCCESS -1 on FAILURE

Note

In case of Failure result memory will be not deallocated, so check the return value before send another m2mb_rtc_open.

m2mb_rtc_close( fd );

m2mb_rtc_ioctl()

INT32 m2mb_rtc_ioctl	(	INT32	fd,
		INT32	request,
			...
	)

Configure a RTC device.

Parameters

[in]	fd	file descriptor returned by m2mb_rtc_open
[in]	request	required operation (see M2MB_RTC_IOCTL_REQUEST_E)

Returns

0 on SUCCESS -1 on FAILURE

Note

M2MB_RTC_TIME_T time; M2MB_RTC_TIMEVAL_T timeval; UINT8 alarmId;

time = ... alarmId = only 0x01

m2mb_rtc_ioctl( fd, M2MB_RTC_IOCTL_GET_SYSTEM_TIME, &time ); m2mb_rtc_ioctl( fd, M2MB_RTC_IOCTL_SET_SYSTEM_TIME, &time ); m2mb_rtc_ioctl( fd, M2MB_RTC_IOCTL_SET_ALARM_TIME, &time, alarmId ); m2mb_rtc_ioctl( fd, M2MB_RTC_IOCTL_CLEAR_ALARM, alarmId ); m2mb_rtc_ioctl( fd, M2MB_RTC_IOCTL_GET_TIMEVAL, &timeval ); m2mb_rtc_ioctl( fd, M2MB_RTC_IOCTL_SET_TIMEVAL, &timeval );

m2mb_rtc_open()

INT32 m2mb_rtc_open	(	const CHAR *	path,
		INT32	flags,
			...
	)

Open a RTC device.

Parameters

[in]	path	/dev/rtc#, where # is in decimal format
[in]	flags	currently unused

Returns

file descriptor on SUCCESS -1 on FAILURE

Note

fd = m2mb_rtc_open( "/dev/rtc0", 0 );