diff options
Diffstat (limited to 'libhw_generic/include/libhw')
| -rw-r--r-- | libhw_generic/include/libhw/generic/io.h | 42 | ||||
| -rw-r--r-- | libhw_generic/include/libhw/generic/net.h | 92 | ||||
| -rw-r--r-- | libhw_generic/include/libhw/generic/spi.h | 2 |
3 files changed, 87 insertions, 49 deletions
diff --git a/libhw_generic/include/libhw/generic/io.h b/libhw_generic/include/libhw/generic/io.h index 9128bd3..a7f7378 100644 --- a/libhw_generic/include/libhw/generic/io.h +++ b/libhw_generic/include/libhw/generic/io.h @@ -8,6 +8,7 @@ #define _LIBHW_GENERIC_IO_H_ #include <stddef.h> /* for size_t */ +#include <sys/types.h> /* for ssize_t */ #include <libobj/obj.h> @@ -31,6 +32,29 @@ struct duplex_iovec { /* basic interfaces ***********************************************************/ /** + * Return bytes-read on success, 0 on EOF, -errno on error; a short + * read is *not* an error. + */ +#define io_reader_LO_IFACE \ + LO_FUNC(ssize_t, readv, const struct iovec *iov, int iovcnt) +LO_INTERFACE(io_reader) +#define io_readv(r, iov, iovcnt) LO_CALL(r, readv, iov, iovcnt) +#define io_read(r, buf, count) LO_CALL(r, readv, &((struct iovec){.iov_base = buf, .iov_len = count}), 1) + +/** + * Return `count` on success, -errno on error; a short write *is* an + * error. + * + * Writes are *not* guaranteed to be atomic, so if you have concurrent + * writers then you should arrange for a mutex to protect the writer. + */ +#define io_writer_LO_IFACE \ + LO_FUNC(ssize_t, writev, const struct iovec *iov, int iovcnt) +LO_INTERFACE(io_writer) +#define io_writev(w, iov, iovcnt) LO_CALL(w, writev, iov, iovcnt) +#define io_write(w, buf, count) LO_CALL(w, writev, &((struct iovec){.iov_base = buf, .iov_len = count}), 1) + +/** * Return 0 on success, -errno on error. */ #define io_closer_LO_IFACE \ @@ -49,4 +73,22 @@ LO_INTERFACE(io_bidi_closer) #define io_close_read(c) LO_CALL(c, close_read) #define io_close_write(c) LO_CALL(c, close_write) +/** + * Return bytes-read and bytes-written on success, -errno on error; a + * short read/write *is* an error. + */ +#define io_duplex_readwriter_LO_IFACE \ + LO_FUNC(void, readwritev, const struct duplex_iovec *iov, int iovcnt) +LO_INTERFACE(io_duplex_readwriter) + +#define io_readwritev(rw, iov, iovcnt) \ + LO_CALL(rw, readwritev, iov, iovcnt) + +/* aggregate interfaces *******************************************************/ + +#define io_readwriter_LO_IFACE \ + LO_NEST(io_reader) \ + LO_NEST(io_writer) +LO_INTERFACE(io_readwriter) + #endif /* _LIBHW_GENERIC_IO_H_ */ diff --git a/libhw_generic/include/libhw/generic/net.h b/libhw_generic/include/libhw/generic/net.h index d70034e..e88d705 100644 --- a/libhw_generic/include/libhw/generic/net.h +++ b/libhw_generic/include/libhw/generic/net.h @@ -72,58 +72,54 @@ lo_interface net_stream_conn; LO_NEST(io_closer) LO_INTERFACE(net_stream_listener) -#define net_stream_conn_LO_IFACE \ - LO_NEST(io_bidi_closer) \ - \ - /** \ - * Return bytes-read on success, 0 on EOF, -errno on error; a \ - * short read is *not* an error. \ - */ \ - LO_FUNC(ssize_t, read, void *buf, size_t count) \ - \ - /** \ - * Set a timestamp after which calls to read() will return \ - * NET_ETIMEDOUT. The timestamp is in nanoseconds on the \ - * system monotonic clock, which is usually (on pico-sdk and \ - * on the Linux kernel) nanoseconds-since-boot. \ - * \ - * A zero value disables the deadline. \ - * \ - * (2⁶⁴-1 nanoseconds is more than 500 years; there is little \ - * risk of this overflowing) \ - */ \ - LO_FUNC(void, set_read_deadline, uint64_t ns_since_boot) \ - \ - /** \ - * Return `count` on success, -errno on error; a short write *is* an \ - * error. \ - * \ - * Writes are *not* guaranteed to be atomic (as this would be \ - * expensive to implement), so if you have concurrent writers then you \ - * should arrange for a mutex to protect the connection. \ - */ \ - LO_FUNC(ssize_t, write, void *buf, size_t count) +#define net_stream_conn_LO_IFACE \ + LO_NEST(io_readwriter) \ + LO_NEST(io_bidi_closer) \ + \ + /** \ + * Set a timestamp after which calls to read() will return \ + * NET_ETIMEDOUT. The timestamp is in nanoseconds on the \ + * system monotonic clock, which is usually (on pico-sdk and \ + * on the Linux kernel) nanoseconds-since-boot. \ + * \ + * A zero value disables the deadline. \ + * \ + * (2⁶⁴-1 nanoseconds is more than 500 years; there is little \ + * risk of this overflowing) \ + */ \ + LO_FUNC(void, set_read_deadline, uint64_t ns_since_boot) LO_INTERFACE(net_stream_conn) /* Packets (e.g. UDP) *********************************************************/ -#define net_packet_conn_LO_IFACE \ - LO_FUNC(ssize_t, sendto, \ - void *buf, size_t len, \ - struct net_ip4_addr node, uint16_t port) \ - \ - /** \ - * @return The full length of the message, which may be more \ - * than the given `len` (as if the Linux MSG_TRUNC flag were \ - * given). \ - */ \ - LO_FUNC(ssize_t, recvfrom, \ - void *buf, size_t len, \ - struct net_ip4_addr *ret_node, uint16_t *ret_port) \ - \ - LO_FUNC(void, set_recv_deadline, \ - uint64_t ns_since_boot) \ - \ +#define net_packet_conn_LO_IFACE \ + LO_FUNC(ssize_t, sendto, \ + void *buf, size_t len, \ + struct net_ip4_addr node, uint16_t port) \ + \ + /** \ + * @return The full length of the message, which may be more \ + * than the given `len` (as if the Linux MSG_TRUNC flag were \ + * given). \ + */ \ + LO_FUNC(ssize_t, recvfrom, \ + void *buf, size_t len, \ + struct net_ip4_addr *ret_node, uint16_t *ret_port) \ + \ + /** \ + * Set a timestamp after which calls to recvfrom() will return \ + * NET_ETIMEDOUT. The timestamp is in nanoseconds on the \ + * system monotonic clock, which is usually (on pico-sdk and \ + * on the Linux kernel) nanoseconds-since-boot. \ + * \ + * A zero value disables the deadline. \ + * \ + * (2⁶⁴-1 nanoseconds is more than 500 years; there is little \ + * risk of this overflowing) \ + */ \ + LO_FUNC(void, set_recv_deadline, \ + uint64_t ns_since_boot) \ + \ LO_NEST(io_closer) LO_INTERFACE(net_packet_conn) diff --git a/libhw_generic/include/libhw/generic/spi.h b/libhw_generic/include/libhw/generic/spi.h index a4b0b22..a4dbcae 100644 --- a/libhw_generic/include/libhw/generic/spi.h +++ b/libhw_generic/include/libhw/generic/spi.h @@ -31,7 +31,7 @@ enum spi_mode { * non-multiple-of-8 number of bits. */ #define spi_LO_IFACE \ - LO_FUNC(void, readwritev, const struct duplex_iovec *iov, int iovcnt) + LO_NEST(io_duplex_readwriter) LO_INTERFACE(spi) #endif /* _LIBHW_GENERIC_SPI_H_ */ |