rtc_max31331.h File Reference

MAX31331 RTC driver specific API. More...

#include <zephyr/device.h>
#include <zephyr/drivers/rtc.h>
#include <zephyr/drivers/gpio.h>
#include <stdint.h>

Go to the source code of this file.

Typedefs
typedef void(*	rtc_max31331_timestamp_callback) (const struct device *dev, void *user_data)
	MAX31331 timestamp callback type.

Functions
int	rtc_max31331_get_timestamps (const struct device *dev, struct rtc_time *timeptr, uint8_t index, uint8_t *flags)
	Read a stored timestamp from the MAX31331.
int	rtc_max31331_set_timestamp_callback (const struct device *dev, rtc_max31331_timestamp_callback cb, void *user_data)
	Register a timestamp event callback.

Detailed Description

MAX31331 RTC driver specific API.

Typedef Documentation

rtc_max31331_timestamp_callback

typedef void(* rtc_max31331_timestamp_callback) (const struct device *dev, void *user_data)

MAX31331 timestamp callback type.

Parameters

dev	Pointer to the RTC device.
user_data	Pointer to user context.

Function Documentation

rtc_max31331_get_timestamps()

int rtc_max31331_get_timestamps	(	const struct device *	dev,
		struct rtc_time *	timeptr,
		uint8_t	index,
		uint8_t *	flags )

Read a stored timestamp from the MAX31331.

Parameters

dev	Pointer to the RTC device.
timeptr	Pointer to struct rtc_time to store result.
index	Timestamp index (0–3).
flags	Pointer to variable receiving timestamp flags.

Return values

0	If successful.
negative	errno code otherwise.

rtc_max31331_set_timestamp_callback()

int rtc_max31331_set_timestamp_callback	(	const struct device *	dev,
		rtc_max31331_timestamp_callback	cb,
		void *	user_data )

Register a timestamp event callback.

Parameters

dev	Pointer to the RTC device.
cb	Callback function pointer.
user_data	Application-provided context.

Return values

0	If successful.
negative	errno code otherwise.