4  * SPDX-License-Identifier: Apache-2.0
31 typedef int (*bbram_api_check_invalid_t)(const struct device *dev);
39 typedef int (*bbram_api_check_standby_power_t)(const struct device *dev);
47 typedef int (*bbram_api_check_power_t)(const struct device *dev);
51  * @brief API template to check the size of the BBRAM
55 typedef int (*bbram_api_get_size_t)(const struct device *dev, size_t *size);
63 typedef int (*bbram_api_read_t)(const struct device *dev, size_t offset, size_t size,
72 typedef int (*bbram_api_write_t)(const struct device *dev, size_t offset, size_t size,
87  * Check if "Invalid Battery-Backed RAM" status is set then reset the status bit. This may occur as
90  * @param[in] dev BBRAM device pointer.
91  * @return 0 if the Battery-Backed RAM data is valid, -EFAULT otherwise.
93 __syscall int bbram_check_invalid(const struct device *dev);
95 static inline int z_impl_bbram_check_invalid(const struct device *dev)  in z_impl_bbram_check_invalid()  argument
98 		(const struct bbram_driver_api *)dev->api;  in z_impl_bbram_check_invalid()
100 	if (!api->check_invalid) {  in z_impl_bbram_check_invalid()
101 		return -ENOTSUP;  in z_impl_bbram_check_invalid()
104 	return api->check_invalid(dev);  in z_impl_bbram_check_invalid()
112  * @param[in] dev BBRAM device pointer.
115 __syscall int bbram_check_standby_power(const struct device *dev);
117 static inline int z_impl_bbram_check_standby_power(const struct device *dev)  in z_impl_bbram_check_standby_power()  argument
120 		(const struct bbram_driver_api *)dev->api;  in z_impl_bbram_check_standby_power()
122 	if (!api->check_standby_power) {  in z_impl_bbram_check_standby_power()
123 		return -ENOTSUP;  in z_impl_bbram_check_standby_power()
126 	return api->check_standby_power(dev);  in z_impl_bbram_check_standby_power()
135  * @param[in] dev BBRAM device pointer.
136  * @return 0 if the V CC1 power domain is in normal operation, -EFAULT otherwise.
138 __syscall int bbram_check_power(const struct device *dev);
140 static inline int z_impl_bbram_check_power(const struct device *dev)  in z_impl_bbram_check_power()  argument
143 		(const struct bbram_driver_api *)dev->api;  in z_impl_bbram_check_power()
145 	if (!api->check_power) {  in z_impl_bbram_check_power()
146 		return -ENOTSUP;  in z_impl_bbram_check_power()
149 	return api->check_power(dev);  in z_impl_bbram_check_power()
153  * @brief Get the size of the BBRAM (in bytes).
155  * @param[in] dev BBRAM device pointer.
156  * @param[out] size Pointer to write the size to.
157  * @return 0 for success, -EFAULT otherwise.
159 __syscall int bbram_get_size(const struct device *dev, size_t *size);
161 static inline int z_impl_bbram_get_size(const struct device *dev, size_t *size)  in z_impl_bbram_get_size()  argument
164 		(const struct bbram_driver_api *)dev->api;  in z_impl_bbram_get_size()
166 	if (!api->get_size) {  in z_impl_bbram_get_size()
167 		return -ENOTSUP;  in z_impl_bbram_get_size()
170 	return api->get_size(dev, size);  in z_impl_bbram_get_size()
176  * @param[in]  dev The BBRAM device pointer to read from.
178  * @param[in]  size The number of bytes to read.
180  * @return 0 on success, -EFAULT if the address range is out of bounds.
182 __syscall int bbram_read(const struct device *dev, size_t offset, size_t size,
185 static inline int z_impl_bbram_read(const struct device *dev, size_t offset,  in z_impl_bbram_read()  argument
186 				    size_t size, uint8_t *data)  in z_impl_bbram_read()  argument
189 		(const struct bbram_driver_api *)dev->api;  in z_impl_bbram_read()
191 	if (!api->read) {  in z_impl_bbram_read()
192 		return -ENOTSUP;  in z_impl_bbram_read()
195 	return api->read(dev, offset, size, data);  in z_impl_bbram_read()
201  * @param[in]  dev The BBRAM device pointer to write to.
203  * @param[in]  size The number of bytes to write.
205  * @return 0 on success, -EFAULT if the address range is out of bounds.
207 __syscall int bbram_write(const struct device *dev, size_t offset, size_t size,
210 static inline int z_impl_bbram_write(const struct device *dev, size_t offset,  in z_impl_bbram_write()  argument
211 				     size_t size, const uint8_t *data)  in z_impl_bbram_write()  argument
214 		(const struct bbram_driver_api *)dev->api;  in z_impl_bbram_write()
216 	if (!api->write) {  in z_impl_bbram_write()
217 		return -ENOTSUP;  in z_impl_bbram_write()
220 	return api->write(dev, offset, size, data);  in z_impl_bbram_write()
228  * @param[in] dev The emulated device to modify
232 int bbram_emul_set_invalid(const struct device *dev, bool is_invalid);
239  * @param[in] dev The emulated device to modify
243 int bbram_emul_set_standby_power_state(const struct device *dev, bool failure);
250  * @param[in] dev The emulated device to modify
254 int bbram_emul_set_power_state(const struct device *dev, bool failure);