Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
sensor.h
Go to the documentation of this file.
1/*
2* Copyright (c) 2016 Intel Corporation
3*
4* SPDX-License-Identifier: Apache-2.0
5*/
6#ifndef ZEPHYR_INCLUDE_DRIVERS_SENSOR_H_
7#define ZEPHYR_INCLUDE_DRIVERS_SENSOR_H_
8
14
27
28#include <errno.h>
29#include <stdlib.h>
30
31#include <zephyr/device.h>
33#include <zephyr/dsp/types.h>
34#include <zephyr/rtio/rtio.h>
36#include <zephyr/types.h>
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
61
117
142
145
158
161
164
169
172
175
184
187
190
233
236
239
242
247
253
258};
259
268#define SENSOR_CHANNEL_3_AXIS(chan) \
269 ((chan) == SENSOR_CHAN_ACCEL_XYZ || (chan) == SENSOR_CHAN_GYRO_XYZ || \
270 (chan) == SENSOR_CHAN_MAGN_XYZ || (chan) == SENSOR_CHAN_POS_DXYZ)
271
280#define SENSOR_CHANNEL_IS_ACCEL(chan) \
281 ((chan) == SENSOR_CHAN_ACCEL_XYZ || (chan) == SENSOR_CHAN_ACCEL_X || \
282 (chan) == SENSOR_CHAN_ACCEL_Y || (chan) == SENSOR_CHAN_ACCEL_Z)
283
292#define SENSOR_CHANNEL_IS_GYRO(chan) \
293 ((chan) == SENSOR_CHAN_GYRO_XYZ || (chan) == SENSOR_CHAN_GYRO_X || \
294 (chan) == SENSOR_CHAN_GYRO_Y || (chan) == SENSOR_CHAN_GYRO_Z)
295
369
379
455
462typedef void (*sensor_trigger_handler_t)(const struct device *dev,
463 const struct sensor_trigger *trigger);
464
469
474typedef int (*sensor_attr_set_t)(const struct device *dev,
475 enum sensor_channel chan,
476 enum sensor_attribute attr,
477 const struct sensor_value *val);
478
483typedef int (*sensor_attr_get_t)(const struct device *dev,
484 enum sensor_channel chan,
485 enum sensor_attribute attr,
486 struct sensor_value *val);
487
492typedef int (*sensor_trigger_set_t)(const struct device *dev,
493 const struct sensor_trigger *trig,
495
500typedef int (*sensor_sample_fetch_t)(const struct device *dev,
501 enum sensor_channel chan);
502
507typedef int (*sensor_channel_get_t)(const struct device *dev,
508 enum sensor_channel chan,
509 struct sensor_value *val);
510
511/* Forward declaration */
512struct sensor_decoder_api;
513
518typedef int (*sensor_get_decoder_t)(const struct device *dev,
519 const struct sensor_decoder_api **api);
520
529typedef void (*sensor_submit_t)(const struct device *sensor, struct rtio_iodev_sqe *sqe);
530
564
567
580
582/* Ensure sensor_chan_spec is sensibly sized to pass by value */
583BUILD_ASSERT(sizeof(struct sensor_chan_spec) <= sizeof(uintptr_t),
584 "sensor_chan_spec size should be equal or less than the size of a machine word");
586
595static inline bool sensor_chan_spec_eq(struct sensor_chan_spec chan_spec0,
596 struct sensor_chan_spec chan_spec1)
597{
598 return chan_spec0.chan_type == chan_spec1.chan_type &&
599 chan_spec0.chan_idx == chan_spec1.chan_idx;
600}
601
619 int (*get_frame_count)(const uint8_t *buffer, struct sensor_chan_spec chan_spec,
620 uint16_t *frame_count);
621
634 int (*get_size_info)(struct sensor_chan_spec channel, size_t *base_size,
635 size_t *frame_size);
636
661 int (*decode)(const uint8_t *buffer, struct sensor_chan_spec chan_spec, uint32_t *fit,
662 uint16_t max_count, void *data_out);
663
671 bool (*has_trigger)(const uint8_t *buffer, enum sensor_trigger_type trigger);
672};
673
704
708#define SENSOR_DECODE_CONTEXT_INIT(decoder_, buffer_, channel_type_, channel_index_) \
709 { \
710 .decoder = (decoder_), \
711 .buffer = (buffer_), \
712 .channel = {.chan_type = (channel_type_), .chan_idx = (channel_index_)}, \
713 .fit = 0, \
714 }
715
724static inline int sensor_decode(struct sensor_decode_context *ctx, void *out, uint16_t max_count)
725{
726 return ctx->decoder->decode(ctx->buffer, ctx->channel, &ctx->fit, max_count, out);
727}
728
730 size_t *frame_size);
731
743
748
749#define SENSOR_STREAM_TRIGGER_PREP(_trigger, _opt) \
750 { \
751 .trigger = (_trigger), .opt = (_opt), \
752 }
753
754/*
755 * Internal data structure used to store information about the IODevice for async reading and
756 * streaming sensor data.
757 */
759 const struct device *sensor;
760 const bool is_streaming;
761 union {
764 };
765 size_t count;
766 const size_t max;
767};
768
784#define SENSOR_DT_READ_IODEV(name, dt_node, ...) \
785 static struct sensor_chan_spec _CONCAT(__channel_array_, name)[] = {__VA_ARGS__}; \
786 static struct sensor_read_config _CONCAT(__sensor_read_config_, name) = { \
787 .sensor = DEVICE_DT_GET(dt_node), \
788 .is_streaming = false, \
789 .channels = _CONCAT(__channel_array_, name), \
790 .count = ARRAY_SIZE(_CONCAT(__channel_array_, name)), \
791 .max = ARRAY_SIZE(_CONCAT(__channel_array_, name)), \
792 }; \
793 RTIO_IODEV_DEFINE(name, &__sensor_iodev_api, _CONCAT(&__sensor_read_config_, name))
794
814#define SENSOR_DT_STREAM_IODEV(name, dt_node, ...) \
815 static struct sensor_stream_trigger _CONCAT(__trigger_array_, name)[] = {__VA_ARGS__}; \
816 static struct sensor_read_config _CONCAT(__sensor_read_config_, name) = { \
817 .sensor = DEVICE_DT_GET(dt_node), \
818 .is_streaming = true, \
819 .triggers = _CONCAT(__trigger_array_, name), \
820 .count = ARRAY_SIZE(_CONCAT(__trigger_array_, name)), \
821 .max = ARRAY_SIZE(_CONCAT(__trigger_array_, name)), \
822 }; \
823 RTIO_IODEV_DEFINE(name, &__sensor_iodev_api, &_CONCAT(__sensor_read_config_, name))
824
825/* The default decoder API */
826extern const struct sensor_decoder_api __sensor_default_decoder;
827
828/* The default sensor iodev API */
829extern const struct rtio_iodev_api __sensor_iodev_api;
830
843__syscall int sensor_attr_set(const struct device *dev,
844 enum sensor_channel chan,
845 enum sensor_attribute attr,
846 const struct sensor_value *val);
847
848static inline int z_impl_sensor_attr_set(const struct device *dev,
849 enum sensor_channel chan,
850 enum sensor_attribute attr,
851 const struct sensor_value *val)
852{
853 const struct sensor_driver_api *api = DEVICE_API_GET(sensor, dev);
854
855 if (api->attr_set == NULL) {
856 return -ENOSYS;
857 }
858
859 return api->attr_set(dev, chan, attr, val);
860}
861
874__syscall int sensor_attr_get(const struct device *dev,
875 enum sensor_channel chan,
876 enum sensor_attribute attr,
877 struct sensor_value *val);
878
879static inline int z_impl_sensor_attr_get(const struct device *dev,
880 enum sensor_channel chan,
881 enum sensor_attribute attr,
882 struct sensor_value *val)
883{
884 const struct sensor_driver_api *api = DEVICE_API_GET(sensor, dev);
885
886 if (api->attr_get == NULL) {
887 return -ENOSYS;
888 }
889
890 return api->attr_get(dev, chan, attr, val);
891}
892
915static inline int sensor_trigger_set(const struct device *dev,
916 const struct sensor_trigger *trig,
918{
919 const struct sensor_driver_api *api = DEVICE_API_GET(sensor, dev);
920
921 if (api->trigger_set == NULL) {
922 return -ENOSYS;
923 }
924
925 return api->trigger_set(dev, trig, handler);
926}
927
946__syscall int sensor_sample_fetch(const struct device *dev);
947
948static inline int z_impl_sensor_sample_fetch(const struct device *dev)
949{
950 return DEVICE_API_GET(sensor, dev)->sample_fetch(dev, SENSOR_CHAN_ALL);
951}
952
974__syscall int sensor_sample_fetch_chan(const struct device *dev,
975 enum sensor_channel type);
976
977static inline int z_impl_sensor_sample_fetch_chan(const struct device *dev,
978 enum sensor_channel type)
979{
980 return DEVICE_API_GET(sensor, dev)->sample_fetch(dev, type);
981}
982
1004__syscall int sensor_channel_get(const struct device *dev,
1005 enum sensor_channel chan,
1006 struct sensor_value *val);
1007
1008static inline int z_impl_sensor_channel_get(const struct device *dev,
1009 enum sensor_channel chan,
1010 struct sensor_value *val)
1011{
1012 return DEVICE_API_GET(sensor, dev)->channel_get(dev, chan, val);
1013}
1014
1015#if defined(CONFIG_SENSOR_ASYNC_API) || defined(__DOXYGEN__)
1016
1017/*
1018 * Generic data structure used for encoding the sample timestamp and number of channels sampled.
1019 */
1020struct __attribute__((__packed__)) sensor_data_generic_header {
1023
1024 /*
1025 ** The number of channels present in the frame.
1026 * This will be the true number of elements in channel_info and in the q31 values that
1027 * follow the header.
1028 */
1030
1033
1034 /* This padding is needed to make sure that the 'channels' field is aligned */
1035 int8_t _padding[sizeof(struct sensor_chan_spec) - 1];
1036
1039};
1040
1049__syscall int sensor_get_decoder(const struct device *dev,
1050 const struct sensor_decoder_api **decoder);
1051
1052static inline int z_impl_sensor_get_decoder(const struct device *dev,
1053 const struct sensor_decoder_api **decoder)
1054{
1055 const struct sensor_driver_api *api = DEVICE_API_GET(sensor, dev);
1056
1057 __ASSERT_NO_MSG(api != NULL);
1058
1059 if (api->get_decoder == NULL) {
1060 *decoder = &__sensor_default_decoder;
1061 return 0;
1062 }
1063
1064 return api->get_decoder(dev, decoder);
1065}
1066
1085__syscall int sensor_reconfigure_read_iodev(const struct rtio_iodev *iodev,
1086 const struct device *sensor,
1087 const struct sensor_chan_spec *channels,
1088 size_t num_channels);
1089
1090static inline int z_impl_sensor_reconfigure_read_iodev(const struct rtio_iodev *iodev,
1091 const struct device *sensor,
1092 const struct sensor_chan_spec *channels,
1093 size_t num_channels)
1094{
1095 struct sensor_read_config *cfg = (struct sensor_read_config *)iodev->data;
1096
1097 if (cfg->max < num_channels || cfg->is_streaming) {
1098 return -ENOMEM;
1099 }
1100
1101 cfg->sensor = sensor;
1102 memcpy(cfg->channels, channels, num_channels * sizeof(struct sensor_chan_spec));
1103 cfg->count = num_channels;
1104 return 0;
1105}
1106
1107static inline int sensor_stream(const struct rtio_iodev *iodev, struct rtio *ctx, void *userdata,
1108 struct rtio_sqe **handle)
1109{
1110 if (IS_ENABLED(CONFIG_USERSPACE)) {
1111 struct rtio_sqe sqe;
1112
1114 rtio_sqe_copy_in_get_handles(ctx, &sqe, handle, 1);
1115 } else {
1116 struct rtio_sqe *sqe = rtio_sqe_acquire(ctx);
1117
1118 if (sqe == NULL) {
1119 return -ENOMEM;
1120 }
1121 if (handle != NULL) {
1122 *handle = sqe;
1123 }
1125 }
1126 rtio_submit(ctx, 0);
1127 return 0;
1128}
1129
1144static inline int sensor_read(const struct rtio_iodev *iodev, struct rtio *ctx, uint8_t *buf,
1145 size_t buf_len)
1146{
1147 if (IS_ENABLED(CONFIG_USERSPACE)) {
1148 struct rtio_sqe sqe;
1149
1151 rtio_sqe_copy_in(ctx, &sqe, 1);
1152 } else {
1153 struct rtio_sqe *sqe = rtio_sqe_acquire(ctx);
1154
1155 if (sqe == NULL) {
1156 return -ENOMEM;
1157 }
1159 }
1160 rtio_submit(ctx, 0);
1161
1162 struct rtio_cqe *cqe = rtio_cqe_consume_block(ctx);
1163 int res = cqe->result;
1164
1165 __ASSERT(cqe->userdata == buf,
1166 "consumed non-matching completion for sensor read into buffer %p\n", buf);
1167
1168 rtio_cqe_release(ctx, cqe);
1169
1170 return res;
1171}
1172
1186static inline int sensor_read_async_mempool(const struct rtio_iodev *iodev, struct rtio *ctx,
1187 void *userdata)
1188{
1189 if (IS_ENABLED(CONFIG_USERSPACE)) {
1190 struct rtio_sqe sqe;
1191
1193 rtio_sqe_copy_in(ctx, &sqe, 1);
1194 } else {
1195 struct rtio_sqe *sqe = rtio_sqe_acquire(ctx);
1196
1197 if (sqe == NULL) {
1198 return -ENOMEM;
1199 }
1201 }
1202 rtio_submit(ctx, 0);
1203 return 0;
1204}
1205
1217 void *userdata);
1218
1231
1232#endif /* defined(CONFIG_SENSOR_ASYNC_API) || defined(__DOXYGEN__) */
1233
1237#define SENSOR_G 9806650LL
1238
1242#define SENSOR_PI 3141592LL
1243
1252static inline int32_t sensor_ms2_to_g(const struct sensor_value *ms2)
1253{
1254 int64_t micro_ms2 = ms2->val1 * 1000000LL + ms2->val2;
1255
1256 if (micro_ms2 > 0) {
1257 return (micro_ms2 + SENSOR_G / 2) / SENSOR_G;
1258 } else {
1259 return (micro_ms2 - SENSOR_G / 2) / SENSOR_G;
1260 }
1261}
1262
1269static inline void sensor_g_to_ms2(int32_t g, struct sensor_value *ms2)
1270{
1271 ms2->val1 = ((int64_t)g * SENSOR_G) / 1000000LL;
1272 ms2->val2 = ((int64_t)g * SENSOR_G) % 1000000LL;
1273}
1274
1283static inline int32_t sensor_ms2_to_mg(const struct sensor_value *ms2)
1284{
1285 int64_t nano_ms2 = (ms2->val1 * 1000000LL + ms2->val2) * 1000LL;
1286
1287 if (nano_ms2 > 0) {
1288 return (nano_ms2 + SENSOR_G / 2) / SENSOR_G;
1289 } else {
1290 return (nano_ms2 - SENSOR_G / 2) / SENSOR_G;
1291 }
1292}
1293
1302static inline int32_t sensor_ms2_to_ug(const struct sensor_value *ms2)
1303{
1304 int64_t micro_ms2 = (ms2->val1 * INT64_C(1000000)) + ms2->val2;
1305
1306 return (micro_ms2 * 1000000LL) / SENSOR_G;
1307}
1308
1315static inline void sensor_ug_to_ms2(int32_t ug, struct sensor_value *ms2)
1316{
1317 ms2->val1 = ((int64_t)ug * SENSOR_G / 1000000LL) / 1000000LL;
1318 ms2->val2 = ((int64_t)ug * SENSOR_G / 1000000LL) % 1000000LL;
1319}
1320
1328static inline int32_t sensor_rad_to_degrees(const struct sensor_value *rad)
1329{
1330 int64_t micro_rad_s = rad->val1 * 1000000LL + rad->val2;
1331
1332 if (micro_rad_s > 0) {
1333 return (micro_rad_s * 180LL + SENSOR_PI / 2) / SENSOR_PI;
1334 } else {
1335 return (micro_rad_s * 180LL - SENSOR_PI / 2) / SENSOR_PI;
1336 }
1337}
1338
1345static inline void sensor_degrees_to_rad(int32_t d, struct sensor_value *rad)
1346{
1347 rad->val1 = ((int64_t)d * SENSOR_PI / 180LL) / 1000000LL;
1348 rad->val2 = ((int64_t)d * SENSOR_PI / 180LL) % 1000000LL;
1349}
1350
1362static inline int32_t sensor_rad_to_10udegrees(const struct sensor_value *rad)
1363{
1364 int64_t micro_rad_s = rad->val1 * 1000000LL + rad->val2;
1365
1366 return (micro_rad_s * 180LL * 100000LL) / SENSOR_PI;
1367}
1368
1375static inline void sensor_10udegrees_to_rad(int32_t d, struct sensor_value *rad)
1376{
1377 rad->val1 = ((int64_t)d * SENSOR_PI / 180LL / 100000LL) / 1000000LL;
1378 rad->val2 = ((int64_t)d * SENSOR_PI / 180LL / 100000LL) % 1000000LL;
1379}
1380
1387static inline double sensor_value_to_double(const struct sensor_value *val)
1388{
1389 return (double)val->val1 + (double)val->val2 / 1000000;
1390}
1391
1398static inline float sensor_value_to_float(const struct sensor_value *val)
1399{
1400 return (float)val->val1 + (float)val->val2 / 1000000;
1401}
1402
1410static inline int sensor_value_from_double(struct sensor_value *val, double inp)
1411{
1412 if (inp < (double)INT32_MIN || inp > (double)INT32_MAX) {
1413 return -ERANGE;
1414 }
1415
1416 int32_t val1 = (int32_t)inp;
1417 int32_t val2 = (int32_t)((inp - (double)val1) * 1000000.0);
1418
1419 val->val1 = val1;
1420 val->val2 = val2;
1421
1422 return 0;
1423}
1424
1432static inline int sensor_value_from_float(struct sensor_value *val, float inp)
1433{
1434 if (inp < (float)INT32_MIN || inp >= (float)INT32_MAX) {
1435 return -ERANGE;
1436 }
1437
1438 int32_t val1 = (int32_t)inp;
1439 int32_t val2 = (int32_t)((inp - (float)val1) * 1000000.0f);
1440
1441 val->val1 = val1;
1442 val->val2 = val2;
1443
1444 return 0;
1445}
1446
1447#ifdef CONFIG_SENSOR_INFO
1448
1449struct sensor_info {
1450 const struct device *dev;
1451 const char *vendor;
1452 const char *model;
1453 const char *friendly_name;
1454};
1455
1456#define SENSOR_INFO_INITIALIZER(_dev, _vendor, _model, _friendly_name) \
1457 { \
1458 .dev = _dev, \
1459 .vendor = _vendor, \
1460 .model = _model, \
1461 .friendly_name = _friendly_name, \
1462 }
1463
1464#define SENSOR_INFO_DEFINE(name, ...) \
1465 static const STRUCT_SECTION_ITERABLE(sensor_info, name) = \
1466 SENSOR_INFO_INITIALIZER(__VA_ARGS__)
1467
1468#define SENSOR_INFO_DT_NAME(node_id) \
1469 _CONCAT(__sensor_info, DEVICE_DT_NAME_GET(node_id))
1470
1471#define SENSOR_INFO_DT_DEFINE(node_id) \
1472 SENSOR_INFO_DEFINE(SENSOR_INFO_DT_NAME(node_id), \
1473 DEVICE_DT_GET(node_id), \
1474 DT_NODE_VENDOR_OR(node_id, NULL), \
1475 DT_NODE_MODEL_OR(node_id, NULL), \
1476 DT_PROP_OR(node_id, friendly_name, NULL)) \
1477
1478#else
1479
1480#define SENSOR_INFO_DEFINE(name, ...)
1481#define SENSOR_INFO_DT_DEFINE(node_id)
1482
1483#endif /* CONFIG_SENSOR_INFO */
1484
1512#define SENSOR_DEVICE_DT_DEFINE(node_id, init_fn, pm_device, \
1513 data_ptr, cfg_ptr, level, prio, \
1514 api_ptr, ...) \
1515 DEVICE_DT_DEFINE(node_id, init_fn, pm_device, \
1516 data_ptr, cfg_ptr, level, prio, \
1517 api_ptr, __VA_ARGS__); \
1518 \
1519 SENSOR_INFO_DT_DEFINE(node_id);
1520
1530#define SENSOR_DEVICE_DT_INST_DEFINE(inst, ...) \
1531 SENSOR_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
1532
1539static inline int64_t sensor_value_to_deci(const struct sensor_value *val)
1540{
1541 return ((int64_t)val->val1 * 10) + val->val2 / 100000;
1542}
1543
1550static inline int64_t sensor_value_to_centi(const struct sensor_value *val)
1551{
1552 return ((int64_t)val->val1 * 100) + val->val2 / 10000;
1553}
1554
1561static inline int64_t sensor_value_to_milli(const struct sensor_value *val)
1562{
1563 return ((int64_t)val->val1 * 1000) + val->val2 / 1000;
1564}
1565
1572static inline int64_t sensor_value_to_micro(const struct sensor_value *val)
1573{
1574 return ((int64_t)val->val1 * 1000000) + val->val2;
1575}
1576
1584static inline int sensor_value_from_milli(struct sensor_value *val, int64_t milli)
1585{
1586 if (milli < ((int64_t)INT32_MIN - 1) * 1000LL ||
1587 milli > ((int64_t)INT32_MAX + 1) * 1000LL) {
1588 return -ERANGE;
1589 }
1590
1591 val->val1 = (int32_t)(milli / 1000);
1592 val->val2 = (int32_t)(milli % 1000) * 1000;
1593
1594 return 0;
1595}
1596
1604static inline int sensor_value_from_micro(struct sensor_value *val, int64_t micro)
1605{
1606 if (micro < ((int64_t)INT32_MIN - 1) * 1000000LL ||
1607 micro > ((int64_t)INT32_MAX + 1) * 1000000LL) {
1608 return -ERANGE;
1609 }
1610
1611 val->val1 = (int32_t)(micro / 1000000LL);
1612 val->val2 = (int32_t)(micro % 1000000LL);
1613
1614 return 0;
1615}
1616
1620
1626#define SENSOR_DECODER_NAME() UTIL_CAT(DT_DRV_COMPAT, __decoder_api)
1627
1635#define SENSOR_DECODER_DT_GET(node_id) \
1636 &UTIL_CAT(DT_STRING_TOKEN_BY_IDX(node_id, compatible, 0), __decoder_api)
1637
1653#define SENSOR_DECODER_API_DT_DEFINE() \
1654 COND_CODE_1(DT_HAS_COMPAT_STATUS_OKAY(DT_DRV_COMPAT), (), (static)) \
1655 const STRUCT_SECTION_ITERABLE(sensor_decoder_api, SENSOR_DECODER_NAME())
1656
1657#define Z_MAYBE_SENSOR_DECODER_DECLARE_INTERNAL_IDX(node_id, prop, idx) \
1658 extern const struct sensor_decoder_api UTIL_CAT( \
1659 DT_STRING_TOKEN_BY_IDX(node_id, prop, idx), __decoder_api);
1660
1661#define Z_MAYBE_SENSOR_DECODER_DECLARE_INTERNAL(node_id) \
1662 COND_CODE_1(DT_NODE_HAS_PROP(node_id, compatible), \
1663 (DT_FOREACH_PROP_ELEM(node_id, compatible, \
1664 Z_MAYBE_SENSOR_DECODER_DECLARE_INTERNAL_IDX)), \
1665 ())
1666
1667DT_FOREACH_STATUS_OKAY_NODE(Z_MAYBE_SENSOR_DECODER_DECLARE_INTERNAL)
1668
1669#ifdef __cplusplus
1670}
1671#endif
1672
1673#include <zephyr/syscalls/sensor.h>
1674
1675#endif /* ZEPHYR_INCLUDE_DRIVERS_SENSOR_H_ */
#define DEVICE_API_GET(_class, _dev)
Expands to the pointer of a device's API for a given class.
Definition device.h:1425
System error numbers.
#define DT_FOREACH_STATUS_OKAY_NODE(fn)
Invokes fn for every status okay node in the tree.
Definition devicetree.h:3296
#define RTIO_PRIO_NORM
Normal priority.
Definition sqe.h:55
static void rtio_sqe_prep_read_with_pool(struct rtio_sqe *sqe, const struct rtio_iodev *iodev, int8_t prio, void *userdata)
Prepare a read op submission with context's mempool.
Definition sqe.h:470
static int rtio_sqe_copy_in(struct rtio *r, const struct rtio_sqe *sqes, size_t sqe_count)
Copy an array of SQEs into the queue.
Definition rtio.h:933
int rtio_sqe_copy_in_get_handles(struct rtio *r, const struct rtio_sqe *sqes, struct rtio_sqe **handle, size_t sqe_count)
Copy an array of SQEs into the queue and get resulting handles back.
static void rtio_sqe_prep_read(struct rtio_sqe *sqe, const struct rtio_iodev *iodev, int8_t prio, uint8_t *buf, uint32_t len, void *userdata)
Prepare a read op submission.
Definition sqe.h:453
static struct rtio_sqe * rtio_sqe_acquire(struct rtio *r)
Acquire a single submission queue event if available.
Definition rtio.h:338
static void rtio_sqe_prep_read_multishot(struct rtio_sqe *sqe, const struct rtio_iodev *iodev, int8_t prio, void *userdata)
Definition sqe.h:478
static void rtio_cqe_release(struct rtio *r, struct rtio_cqe *cqe)
Release consumed completion queue event.
Definition rtio.h:512
static struct rtio_cqe * rtio_cqe_consume_block(struct rtio *r)
Wait for and consume a single completion queue event.
Definition rtio.h:488
int rtio_submit(struct rtio *r, uint32_t wait_count)
Submit I/O requests to the underlying executor.
int(* sensor_attr_get_t)(const struct device *dev, enum sensor_channel chan, enum sensor_attribute attr, struct sensor_value *val)
Callback API to get a sensor attribute.
Definition sensor.h:483
int(* sensor_get_decoder_t)(const struct device *dev, const struct sensor_decoder_api **api)
Callback API to get the sensor decoder implementation.
Definition sensor.h:518
int(* sensor_attr_set_t)(const struct device *dev, enum sensor_channel chan, enum sensor_attribute attr, const struct sensor_value *val)
Callback API to set a sensor attribute.
Definition sensor.h:474
int(* sensor_channel_get_t)(const struct device *dev, enum sensor_channel chan, struct sensor_value *val)
Callback API to read a sensor channel from the driver buffer.
Definition sensor.h:507
int(* sensor_sample_fetch_t)(const struct device *dev, enum sensor_channel chan)
Callback API to fetch a sensor sample into the driver buffer.
Definition sensor.h:500
void(* sensor_submit_t)(const struct device *sensor, struct rtio_iodev_sqe *sqe)
Callback API to service an RTIO submission for a sensor device.
Definition sensor.h:529
int(* sensor_trigger_set_t)(const struct device *dev, const struct sensor_trigger *trig, sensor_trigger_handler_t handler)
Callback API to set a sensor trigger and handler.
Definition sensor.h:492
#define SENSOR_G
The value of gravitational constant in micro m/s^2.
Definition sensor.h:1237
static int sensor_decode(struct sensor_decode_context *ctx, void *out, uint16_t max_count)
Decode N frames using a sensor_decode_context.
Definition sensor.h:724
static int sensor_stream(const struct rtio_iodev *iodev, struct rtio *ctx, void *userdata, struct rtio_sqe **handle)
Definition sensor.h:1107
static int32_t sensor_rad_to_degrees(const struct sensor_value *rad)
Helper function for converting radians to degrees.
Definition sensor.h:1328
sensor_trigger_type
Sensor trigger types.
Definition sensor.h:299
sensor_attribute
Sensor attribute types.
Definition sensor.h:383
int sensor_get_decoder(const struct device *dev, const struct sensor_decoder_api **decoder)
Get the sensor's decoder API.
static void sensor_ug_to_ms2(int32_t ug, struct sensor_value *ms2)
Helper function to convert acceleration from micro Gs to m/s^2.
Definition sensor.h:1315
static double sensor_value_to_double(const struct sensor_value *val)
Helper function for converting struct sensor_value to double.
Definition sensor.h:1387
static float sensor_value_to_float(const struct sensor_value *val)
Helper function for converting struct sensor_value to float.
Definition sensor.h:1398
int sensor_natively_supported_channel_size_info(struct sensor_chan_spec channel, size_t *base_size, size_t *frame_size)
static void sensor_degrees_to_rad(int32_t d, struct sensor_value *rad)
Helper function for converting degrees to radians.
Definition sensor.h:1345
static int32_t sensor_ms2_to_ug(const struct sensor_value *ms2)
Helper function to convert acceleration from m/s^2 to micro Gs.
Definition sensor.h:1302
static int sensor_value_from_float(struct sensor_value *val, float inp)
Helper function for converting float to struct sensor_value.
Definition sensor.h:1432
static void sensor_g_to_ms2(int32_t g, struct sensor_value *ms2)
Helper function to convert acceleration from Gs to m/s^2.
Definition sensor.h:1269
static int64_t sensor_value_to_milli(const struct sensor_value *val)
Helper function for converting struct sensor_value to integer milli units.
Definition sensor.h:1561
#define SENSOR_PI
The value of constant PI in micros.
Definition sensor.h:1242
int sensor_reconfigure_read_iodev(const struct rtio_iodev *iodev, const struct device *sensor, const struct sensor_chan_spec *channels, size_t num_channels)
Reconfigure a reading iodev.
static int sensor_trigger_set(const struct device *dev, const struct sensor_trigger *trig, sensor_trigger_handler_t handler)
Activate a sensor's trigger and set the trigger handler.
Definition sensor.h:915
sensor_stream_data_opt
Options for what to do with the associated data when a trigger is consumed.
Definition sensor.h:735
static int sensor_value_from_milli(struct sensor_value *val, int64_t milli)
Helper function for converting integer milli units to struct sensor_value.
Definition sensor.h:1584
void(* sensor_trigger_handler_t)(const struct device *dev, const struct sensor_trigger *trigger)
Callback API upon firing of a trigger.
Definition sensor.h:462
static int64_t sensor_value_to_micro(const struct sensor_value *val)
Helper function for converting struct sensor_value to integer micro units.
Definition sensor.h:1572
int sensor_channel_get(const struct device *dev, enum sensor_channel chan, struct sensor_value *val)
Get a reading from a sensor device.
static int32_t sensor_ms2_to_mg(const struct sensor_value *ms2)
Helper function to convert acceleration from m/s^2 to milli Gs.
Definition sensor.h:1283
int sensor_sample_fetch(const struct device *dev)
Fetch a sample from the sensor and store it in an internal driver buffer.
void(* sensor_processing_callback_t)(int result, uint8_t *buf, uint32_t buf_len, void *userdata)
Callback function used with the helper processing function.
Definition sensor.h:1216
sensor_channel
Sensor channels.
Definition sensor.h:65
static void sensor_10udegrees_to_rad(int32_t d, struct sensor_value *rad)
Helper function for converting 10 micro degrees to radians.
Definition sensor.h:1375
static int32_t sensor_ms2_to_g(const struct sensor_value *ms2)
Helper function to convert acceleration from m/s^2 to Gs.
Definition sensor.h:1252
void sensor_processing_with_callback(struct rtio *ctx, sensor_processing_callback_t cb)
Helper function for common processing of sensor data.
static int64_t sensor_value_to_deci(const struct sensor_value *val)
Helper function for converting struct sensor_value to integer deci units.
Definition sensor.h:1539
static int sensor_value_from_micro(struct sensor_value *val, int64_t micro)
Helper function for converting integer micro units to struct sensor_value.
Definition sensor.h:1604
int sensor_sample_fetch_chan(const struct device *dev, enum sensor_channel type)
Fetch a sample from the sensor and store it in an internal driver buffer.
static int sensor_read(const struct rtio_iodev *iodev, struct rtio *ctx, uint8_t *buf, size_t buf_len)
Blocking one shot read of samples from a sensor into a buffer.
Definition sensor.h:1144
static int32_t sensor_rad_to_10udegrees(const struct sensor_value *rad)
Helper function for converting radians to 10 micro degrees.
Definition sensor.h:1362
static int64_t sensor_value_to_centi(const struct sensor_value *val)
Helper function for converting struct sensor_value to integer centi units.
Definition sensor.h:1550
static bool sensor_chan_spec_eq(struct sensor_chan_spec chan_spec0, struct sensor_chan_spec chan_spec1)
Check if channel specs are equivalent.
Definition sensor.h:595
int sensor_attr_get(const struct device *dev, enum sensor_channel chan, enum sensor_attribute attr, struct sensor_value *val)
Get an attribute for a sensor.
static int sensor_value_from_double(struct sensor_value *val, double inp)
Helper function for converting double to struct sensor_value.
Definition sensor.h:1410
static int sensor_read_async_mempool(const struct rtio_iodev *iodev, struct rtio *ctx, void *userdata)
One shot non-blocking read with pool allocated buffer.
Definition sensor.h:1186
int sensor_attr_set(const struct device *dev, enum sensor_channel chan, enum sensor_attribute attr, const struct sensor_value *val)
Set an attribute for a sensor.
@ SENSOR_TRIG_OVERFLOW
Trigger fires when data overflows.
Definition sensor.h:351
@ SENSOR_TRIG_DELTA
Trigger fires when the selected channel varies significantly.
Definition sensor.h:315
@ SENSOR_TRIG_NEAR_FAR
Trigger fires when a near/far event is detected.
Definition sensor.h:317
@ SENSOR_TRIG_FREEFALL
Trigger fires when a free fall is detected.
Definition sensor.h:333
@ SENSOR_TRIG_PRIV_START
This and higher values are sensor specific.
Definition sensor.h:362
@ SENSOR_TRIG_FIFO_FULL
Trigger fires when the FIFO becomes full.
Definition sensor.h:345
@ SENSOR_TRIG_MOTION
Trigger fires when motion is detected.
Definition sensor.h:336
@ SENSOR_TRIG_STATIONARY
Trigger fires when no motion has been detected for a while.
Definition sensor.h:339
@ SENSOR_TRIG_COMMON_COUNT
Number of all common sensor triggers.
Definition sensor.h:356
@ SENSOR_TRIG_THRESHOLD
Trigger fires when channel reading transitions configured thresholds.
Definition sensor.h:324
@ SENSOR_TRIG_MAX
Maximum value describing a sensor trigger type.
Definition sensor.h:367
@ SENSOR_TRIG_DOUBLE_TAP
Trigger fires when a double tap is detected.
Definition sensor.h:330
@ SENSOR_TRIG_TILT
Trigger fires when a tilt is detected.
Definition sensor.h:348
@ SENSOR_TRIG_TIMER
Timer-based trigger, useful when the sensor does not have an interrupt line.
Definition sensor.h:304
@ SENSOR_TRIG_FIFO_WATERMARK
Trigger fires when the FIFO watermark has been reached.
Definition sensor.h:342
@ SENSOR_TRIG_TAP
Trigger fires when a single tap is detected.
Definition sensor.h:327
@ SENSOR_TRIG_DATA_READY
Trigger fires whenever new data is ready.
Definition sensor.h:306
@ SENSOR_ATTR_HYSTERESIS
Definition sensor.h:401
@ SENSOR_ATTR_FEATURE_MASK
Enable/disable sensor features.
Definition sensor.h:421
@ SENSOR_ATTR_CALIB_TARGET
Calibration target.
Definition sensor.h:415
@ SENSOR_ATTR_OFFSET
The sensor value returned will be altered by the amount indicated by offset: final_value = sensor_val...
Definition sensor.h:410
@ SENSOR_ATTR_BATCH_DURATION
Hardware batch duration in ticks.
Definition sensor.h:432
@ SENSOR_ATTR_OVERSAMPLING
Oversampling factor.
Definition sensor.h:403
@ SENSOR_ATTR_FF_DUR
Free-fall duration represented in milliseconds.
Definition sensor.h:429
@ SENSOR_ATTR_UPPER_THRESH
Upper threshold for trigger.
Definition sensor.h:392
@ SENSOR_ATTR_CONFIGURATION
Configure the operating modes of a sensor.
Definition sensor.h:417
@ SENSOR_ATTR_RESOLUTION
Configure the resolution of a sensor.
Definition sensor.h:436
@ SENSOR_ATTR_CALIBRATION
Set a calibration value needed by a sensor.
Definition sensor.h:419
@ SENSOR_ATTR_CHIP_ID
Chip ID of a sensor.
Definition sensor.h:438
@ SENSOR_ATTR_COMMON_COUNT
Number of all common sensor attributes.
Definition sensor.h:442
@ SENSOR_ATTR_ALERT
Alert threshold or alert enable/disable.
Definition sensor.h:423
@ SENSOR_ATTR_SLOPE_TH
Threshold for any-motion (slope) trigger.
Definition sensor.h:394
@ SENSOR_ATTR_GAIN
Configure the gain of a sensor.
Definition sensor.h:434
@ SENSOR_ATTR_SAMPLING_FREQUENCY
Sensor sampling frequency, i.e.
Definition sensor.h:388
@ SENSOR_ATTR_FULL_SCALE
Sensor range, in SI units.
Definition sensor.h:405
@ SENSOR_ATTR_LOWER_THRESH
Lower threshold for trigger.
Definition sensor.h:390
@ SENSOR_ATTR_SLOPE_DUR
Duration for which the slope values needs to be outside the threshold for the trigger to fire.
Definition sensor.h:399
@ SENSOR_ATTR_MAX
Maximum value describing a sensor attribute type.
Definition sensor.h:453
@ SENSOR_ATTR_PRIV_START
This and higher values are sensor specific.
Definition sensor.h:448
@ SENSOR_STREAM_DATA_INCLUDE
Include whatever data is associated with the trigger.
Definition sensor.h:737
@ SENSOR_STREAM_DATA_NOP
Do nothing with the associated trigger data, it may be consumed later.
Definition sensor.h:739
@ SENSOR_STREAM_DATA_DROP
Flush/clear whatever data is associated with the trigger.
Definition sensor.h:741
@ SENSOR_CHAN_GAUGE_STATE_OF_HEALTH
State of health measurement in %.
Definition sensor.h:214
@ SENSOR_CHAN_PM_1_0_CF
PM1.0 concentration (standard particle, CF=1), in µg/m³
Definition sensor.h:119
@ SENSOR_CHAN_PM_1_0
1.0 micro-meters Particulate Matter, in ug/m^3
Definition sensor.h:125
@ SENSOR_CHAN_DIE_TEMP
Device die temperature in degrees Celsius.
Definition sensor.h:91
@ SENSOR_CHAN_PRESS
Pressure in kilopascal.
Definition sensor.h:95
@ SENSOR_CHAN_GAUGE_TIME_TO_FULL
Time to full in minutes.
Definition sensor.h:218
@ SENSOR_CHAN_ACCEL_XYZ
Acceleration on the X, Y and Z axes.
Definition sensor.h:73
@ SENSOR_CHAN_MAGN_X
Magnetic field on the X axis, in G.
Definition sensor.h:83
@ SENSOR_CHAN_O2
O2 level, in parts per million (ppm).
Definition sensor.h:149
@ SENSOR_CHAN_CURRENT
Current, in amps.
Definition sensor.h:166
@ SENSOR_CHAN_GYRO_XYZ
Angular velocity around the X, Y and Z axes.
Definition sensor.h:81
@ SENSOR_CHAN_VSHUNT
Current Shunt Voltage in milli-volts.
Definition sensor.h:163
@ SENSOR_CHAN_GREEN
Illuminance in green spectrum, in lux.
Definition sensor.h:112
@ SENSOR_CHAN_GRAVITY_VECTOR
Gravity Vector (X/Y/Z components in m/s^2).
Definition sensor.h:230
@ SENSOR_CHAN_MAGN_Z
Magnetic field on the Z axis, in G.
Definition sensor.h:87
@ SENSOR_CHAN_MAGN_Y
Magnetic field on the Y axis, in G.
Definition sensor.h:85
@ SENSOR_CHAN_GAUGE_DESIRED_VOLTAGE
Desired voltage of cell in V (nominal voltage).
Definition sensor.h:224
@ SENSOR_CHAN_POWER
Power in watts.
Definition sensor.h:168
@ SENSOR_CHAN_PM_2_5
2.5 micro-meters Particulate Matter, in ug/m^3
Definition sensor.h:127
@ SENSOR_CHAN_RESISTANCE
Resistance , in Ohm.
Definition sensor.h:171
@ SENSOR_CHAN_GAME_ROTATION_VECTOR
Game Rotation Vector (unit quaternion components X/Y/Z/W).
Definition sensor.h:228
@ SENSOR_CHAN_AMBIENT_LIGHT
Ambient illuminance in visible spectrum, in lux.
Definition sensor.h:104
@ SENSOR_CHAN_PM_0_5_COUNT
Number of particles ≥ 0.5 µm per 0.1 liter of air.
Definition sensor.h:133
@ SENSOR_CHAN_GAUGE_AVG_CURRENT
Average current, in amps (negative=discharging).
Definition sensor.h:194
@ SENSOR_CHAN_ENCODER_COUNT
Raw quadrature decoder count, in counts.
Definition sensor.h:235
@ SENSOR_CHAN_GYRO_Y
Angular velocity around the Y axis, in rad/s.
Definition sensor.h:77
@ SENSOR_CHAN_GAUGE_DESIRED_CHARGING_CURRENT
Desired charging current in mA.
Definition sensor.h:226
@ SENSOR_CHAN_FREQUENCY
Frequency, in Hz.
Definition sensor.h:189
@ SENSOR_CHAN_PM_2_5_CF
PM2.5 concentration (standard particle, CF=1), in µg/m³
Definition sensor.h:121
@ SENSOR_CHAN_GAUGE_FULL_CHARGE_CAPACITY
Full Charge Capacity in mAh.
Definition sensor.h:204
@ SENSOR_CHAN_ROTATION
Angular rotation, in degrees.
Definition sensor.h:174
@ SENSOR_CHAN_AMBIENT_TEMP
Ambient temperature in degrees Celsius.
Definition sensor.h:93
@ SENSOR_CHAN_MAGN_XYZ
Magnetic field on the X, Y and Z axes.
Definition sensor.h:89
@ SENSOR_CHAN_GAUGE_STDBY_CURRENT
Standby current, in amps (negative=discharging).
Definition sensor.h:196
@ SENSOR_CHAN_GAUGE_MAX_LOAD_CURRENT
Max load current, in amps (negative=discharging).
Definition sensor.h:198
@ SENSOR_CHAN_ACCEL_Y
Acceleration on the Y axis, in m/s^2.
Definition sensor.h:69
@ SENSOR_CHAN_RPM
Revolutions per minute, in RPM.
Definition sensor.h:186
@ SENSOR_CHAN_GAUGE_FULL_AVAIL_CAPACITY
Full Available Capacity in mAh.
Definition sensor.h:210
@ SENSOR_CHAN_VOLTAGE
Voltage, in volts.
Definition sensor.h:160
@ SENSOR_CHAN_FLOW_RATE
Flow rate in liters per minute.
Definition sensor.h:155
@ SENSOR_CHAN_VOLUME
Flow volume in liters.
Definition sensor.h:157
@ SENSOR_CHAN_BLUE
Illuminance in blue spectrum, in lux.
Definition sensor.h:114
@ SENSOR_CHAN_LIGHT
Illuminance in visible spectrum, in lux.
Definition sensor.h:106
@ SENSOR_CHAN_GAUGE_DESIGN_VOLTAGE
Design voltage of cell in V (max voltage).
Definition sensor.h:222
@ SENSOR_CHAN_PM_5_COUNT
Number of particles ≥ 5.0 µm per 0.1 liter of air.
Definition sensor.h:139
@ SENSOR_CHAN_ACCEL_Z
Acceleration on the Z axis, in m/s^2.
Definition sensor.h:71
@ SENSOR_CHAN_CO2
CO2 level, in parts per million (ppm).
Definition sensor.h:147
@ SENSOR_CHAN_GAUGE_STATE_OF_CHARGE
State of charge measurement in %.
Definition sensor.h:202
@ SENSOR_CHAN_POS_DXYZ
Position change on the X, Y and Z axis, in points.
Definition sensor.h:183
@ SENSOR_CHAN_GBIAS_XYZ
Gyroscope bias (X/Y/Z components in rad/s).
Definition sensor.h:232
@ SENSOR_CHAN_GAUGE_CYCLE_COUNT
Cycle count (total number of charge/discharge cycles).
Definition sensor.h:220
@ SENSOR_CHAN_GAUGE_TEMP
Gauge temperature.
Definition sensor.h:200
@ SENSOR_CHAN_POS_DY
Position change on the Y axis, in points.
Definition sensor.h:179
@ SENSOR_CHAN_GYRO_Z
Angular velocity around the Z axis, in rad/s.
Definition sensor.h:79
@ SENSOR_CHAN_PM_10_CF
PM10 concentration (standard particle, CF=1), in µg/m³
Definition sensor.h:123
@ SENSOR_CHAN_POS_DX
Position change on the X axis, in points.
Definition sensor.h:177
@ SENSOR_CHAN_GAUGE_AVG_POWER
Average power in mW.
Definition sensor.h:212
@ SENSOR_CHAN_GAUGE_TIME_TO_EMPTY
Time to empty in minutes.
Definition sensor.h:216
@ SENSOR_CHAN_PM_10
10 micro-meters Particulate Matter, in ug/m^3
Definition sensor.h:129
@ SENSOR_CHAN_ENCODER_REVOLUTIONS
Number of revolutions for quadrature decoder.
Definition sensor.h:238
@ SENSOR_CHAN_GAUGE_REMAINING_CHARGE_CAPACITY
Remaining Charge Capacity in mAh.
Definition sensor.h:206
@ SENSOR_CHAN_PM_1_0_COUNT
Number of particles ≥ 1.0 µm per 0.1 liter of air.
Definition sensor.h:135
@ SENSOR_CHAN_PM_0_3_COUNT
Number of particles ≥ 0.3 µm per 0.1 liter of air.
Definition sensor.h:131
@ SENSOR_CHAN_PM_10_COUNT
Number of particles ≥ 10.0 µm per 0.1 liter of air.
Definition sensor.h:141
@ SENSOR_CHAN_ALL
All channels.
Definition sensor.h:241
@ SENSOR_CHAN_GAUGE_VOLTAGE
Voltage, in volts.
Definition sensor.h:192
@ SENSOR_CHAN_PROX
Proximity.
Definition sensor.h:100
@ SENSOR_CHAN_COMMON_COUNT
Number of all common sensor channels.
Definition sensor.h:246
@ SENSOR_CHAN_PRIV_START
This and higher values are sensor specific.
Definition sensor.h:252
@ SENSOR_CHAN_GYRO_X
Angular velocity around the X axis, in rad/s.
Definition sensor.h:75
@ SENSOR_CHAN_GAS_RES
Gas sensor resistance in ohms.
Definition sensor.h:153
@ SENSOR_CHAN_HUMIDITY
Humidity, in percent.
Definition sensor.h:102
@ SENSOR_CHAN_DISTANCE
Distance.
Definition sensor.h:144
@ SENSOR_CHAN_IR
Illuminance in infra-red spectrum, in lux.
Definition sensor.h:108
@ SENSOR_CHAN_MAX
Maximum value describing a sensor channel type.
Definition sensor.h:257
@ SENSOR_CHAN_PM_2_5_COUNT
Number of particles ≥ 2.5 µm per 0.1 liter of air.
Definition sensor.h:137
@ SENSOR_CHAN_POS_DZ
Position change on the Z axis, in points.
Definition sensor.h:181
@ SENSOR_CHAN_RED
Illuminance in red spectrum, in lux.
Definition sensor.h:110
@ SENSOR_CHAN_ALTITUDE
Altitude, in meters.
Definition sensor.h:116
@ SENSOR_CHAN_GAUGE_NOM_AVAIL_CAPACITY
Nominal Available Capacity in mAh.
Definition sensor.h:208
@ SENSOR_CHAN_ACCEL_X
Acceleration on the X axis, in m/s^2.
Definition sensor.h:67
@ SENSOR_CHAN_VOC
VOC level, in parts per billion (ppb).
Definition sensor.h:151
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:154
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define ENOMEM
Not enough core.
Definition errno.h:50
#define ERANGE
Result too large.
Definition errno.h:72
Real-Time IO device API for moving bytes with low effort.
#define bool
Definition stdbool.h:13
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INT32_TYPE__ int32_t
Definition stdint.h:74
#define INT32_MAX
Definition stdint.h:18
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINTPTR_TYPE__ uintptr_t
Definition stdint.h:105
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
#define INT32_MIN
Definition stdint.h:24
#define INT16_MAX
Definition stdint.h:17
__INT64_TYPE__ int64_t
Definition stdint.h:75
__INT8_TYPE__ int8_t
Definition stdint.h:72
void * memcpy(void *ZRESTRICT d, const void *ZRESTRICT s, size_t n)
Runtime device structure (in ROM) per driver instance.
Definition device.h:513
A completion queue event.
Definition cqe.h:83
void * userdata
Associated userdata with operation.
Definition cqe.h:87
int32_t result
Result from operation.
Definition cqe.h:86
API that an RTIO IO device should implement.
Definition iodev.h:33
IO device submission queue entry.
Definition sqe.h:394
struct rtio_sqe sqe
Definition sqe.h:395
An IO device with a function table for submitting requests.
Definition iodev.h:48
void * data
Definition iodev.h:53
A submission queue event.
Definition sqe.h:304
void * userdata
User provided data which is returned upon operation completion.
Definition sqe.h:322
uint32_t buf_len
Length of buffer.
Definition sqe.h:328
const struct rtio_iodev * iodev
Device to operation on.
Definition sqe.h:313
const uint8_t * buf
Buffer to write from.
Definition sqe.h:329
An RTIO context containing what can be viewed as a pair of queues.
Definition rtio.h:70
Sensor Channel Specification.
Definition sensor.h:576
uint16_t chan_idx
A sensor channel index.
Definition sensor.h:578
uint16_t chan_type
A sensor channel type.
Definition sensor.h:577
Definition sensor.h:1020
uint64_t timestamp_ns
The timestamp at which the data was collected from the sensor.
Definition sensor.h:1022
int8_t shift
Shift value for all samples in the frame.
Definition sensor.h:1032
uint32_t num_channels
Definition sensor.h:1029
struct sensor_chan_spec channels[0]
Channels present in the frame.
Definition sensor.h:1038
Used for iterating over the data frames via the sensor_decoder_api.
Definition sensor.h:698
const struct sensor_decoder_api * decoder
Definition sensor.h:699
struct sensor_chan_spec channel
Definition sensor.h:701
const uint8_t * buffer
Definition sensor.h:700
uint32_t fit
Definition sensor.h:702
Decodes a single raw data buffer.
Definition sensor.h:608
int(* get_size_info)(struct sensor_chan_spec channel, size_t *base_size, size_t *frame_size)
Get the size required to decode a given channel.
Definition sensor.h:634
int(* get_frame_count)(const uint8_t *buffer, struct sensor_chan_spec chan_spec, uint16_t *frame_count)
Get the frame_count for a specified chan_spec from the buffer.
Definition sensor.h:619
int(* decode)(const uint8_t *buffer, struct sensor_chan_spec chan_spec, uint32_t *fit, uint16_t max_count, void *data_out)
Decode up to max_count frames specified by chan_spec from the buffer.
Definition sensor.h:661
bool(* has_trigger)(const uint8_t *buffer, enum sensor_trigger_type trigger)
Check if the given trigger type is present.
Definition sensor.h:671
<span class="mlabel">Driver Operations</span> Sensor driver operations
Definition sensor.h:534
sensor_get_decoder_t get_decoder
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition sensor.h:558
sensor_attr_set_t attr_set
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition sensor.h:538
sensor_attr_get_t attr_get
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition sensor.h:542
sensor_trigger_set_t trigger_set
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition sensor.h:546
sensor_sample_fetch_t sample_fetch
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition sensor.h:550
sensor_channel_get_t channel_get
<span class="op-badge op-req" title="This operation MUST be implemented by the driver....
Definition sensor.h:554
sensor_submit_t submit
<span class="op-badge op-opt" title="This operation MAY optionally be implemented by the driver....
Definition sensor.h:562
Definition sensor.h:758
struct sensor_chan_spec *const channels
Definition sensor.h:762
size_t count
Definition sensor.h:765
struct sensor_stream_trigger *const triggers
Definition sensor.h:763
const bool is_streaming
Definition sensor.h:760
const struct device * sensor
Definition sensor.h:759
const size_t max
Definition sensor.h:766
Definition sensor.h:744
enum sensor_stream_data_opt opt
Definition sensor.h:746
enum sensor_trigger_type trigger
Definition sensor.h:745
Sensor trigger spec.
Definition sensor.h:373
enum sensor_trigger_type type
Trigger type.
Definition sensor.h:375
enum sensor_channel chan
Channel the trigger is set on.
Definition sensor.h:377
Representation of a sensor readout value.
Definition sensor.h:55
int32_t val2
Fractional part of the value (in one-millionth parts).
Definition sensor.h:59
int32_t val1
Integer part of the value.
Definition sensor.h:57
Iterable sections helpers.