From b6f218867b9e24a5a0e9f11b57523a715f07b389 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 5 Nov 2014 10:21:34 +0100 Subject: Add RTEMS port of Linux I2C user-space API --- cpukit/Makefile.am | 1 + cpukit/configure.ac | 1 + cpukit/dev/Makefile.am | 12 ++ cpukit/dev/include/linux/i2c-dev.h | 137 +++++++++++++++++++ cpukit/dev/include/linux/i2c.h | 274 +++++++++++++++++++++++++++++++++++++ cpukit/dev/preinstall.am | 33 +++++ 6 files changed, 458 insertions(+) create mode 100644 cpukit/dev/Makefile.am create mode 100644 cpukit/dev/include/linux/i2c-dev.h create mode 100644 cpukit/dev/include/linux/i2c.h create mode 100644 cpukit/dev/preinstall.am diff --git a/cpukit/Makefile.am b/cpukit/Makefile.am index 5e0ae72ba8..b9e9992236 100644 --- a/cpukit/Makefile.am +++ b/cpukit/Makefile.am @@ -5,6 +5,7 @@ include $(top_srcdir)/automake/multilib.am # librtemscpu SUBDIRS = . score rtems sapi posix +SUBDIRS += dev SUBDIRS += libcsupport libblock libfs SUBDIRS += libnetworking librpc SUBDIRS += libi2c diff --git a/cpukit/configure.ac b/cpukit/configure.ac index d5b6eb377a..a42989df69 100644 --- a/cpukit/configure.ac +++ b/cpukit/configure.ac @@ -391,6 +391,7 @@ RTEMS_AMPOLISH3 AC_CONFIG_FILES([ Doxyfile Makefile +dev/Makefile rtems/Makefile sapi/Makefile score/Makefile diff --git a/cpukit/dev/Makefile.am b/cpukit/dev/Makefile.am new file mode 100644 index 0000000000..5f8fee6b71 --- /dev/null +++ b/cpukit/dev/Makefile.am @@ -0,0 +1,12 @@ +include $(top_srcdir)/automake/compile.am + +include_devdir = $(includedir)/dev +include_dev_HEADERS = + +include_linuxdir = $(includedir)/linux +include_linux_HEADERS = +include_linux_HEADERS += include/linux/i2c.h +include_linux_HEADERS += include/linux/i2c-dev.h + +include $(srcdir)/preinstall.am +include $(top_srcdir)/automake/local.am diff --git a/cpukit/dev/include/linux/i2c-dev.h b/cpukit/dev/include/linux/i2c-dev.h new file mode 100644 index 0000000000..c0db3fe06c --- /dev/null +++ b/cpukit/dev/include/linux/i2c-dev.h @@ -0,0 +1,137 @@ +/** + * @file + * + * @brief RTEMS Port of Linux I2C Device API + * + * @ingroup I2CLinux + */ + +/* + * Copyright (c) 2014 embedded brains GmbH. All rights reserved. + * + * embedded brains GmbH + * Dornierstr. 4 + * 82178 Puchheim + * Germany + * + * + * The license and distribution terms for this file may be + * found in the file LICENSE in this distribution or at + * http://www.rtems.org/license/LICENSE. + */ + +#ifndef _UAPI_LINUX_I2C_DEV_H +#define _UAPI_LINUX_I2C_DEV_H + +#include + +/** + * @addtogroup I2CLinux + * + * @{ + */ + +/** + * @name I2C IO Control Commands + * + * @{ + */ + +/** + * @brief Sets the count of transfer retries in case a slave + * device does not acknowledge a transaction. + * + * The argument type is unsigned long. + */ +#define I2C_RETRIES 0x701 + +/** + * @brief Sets the transfer timeout in 10ms units. + * + * The argument type is unsigned long. + */ +#define I2C_TIMEOUT 0x702 + +/** + * @brief Sets the slave address. + * + * It is an error to set a slave address already used by another slave device. + * + * The argument type is unsigned long. + */ +#define I2C_SLAVE 0x703 + +/** + * @brief Forces setting the slave address. + * + * The argument type is unsigned long. + */ +#define I2C_SLAVE_FORCE 0x706 + +/** + * @brief Enables 10-bit addresses if argument is non-zero, otherwise + * disables 10-bit addresses. + * + * The argument type is unsigned long. + */ +#define I2C_TENBIT 0x704 + +/** + * @brief Gets the I2C controller functionality information. + * + * The argument type is a pointer to an unsigned long. + */ +#define I2C_FUNCS 0x705 + +/** + * @brief Performs a combined read/write transfer. + * + * Only one stop condition is signalled. + * + * The argument type is a pointer to struct i2c_rdwr_ioctl_data. + */ +#define I2C_RDWR 0x707 + +/** + * @brief Enables System Management Bus (SMBus) Packet Error Checking (PEC) + * if argument is non-zero, otherwise disables PEC. + * + * The argument type is unsigned long. + */ +#define I2C_PEC 0x708 + +/** + * @brief Performs an SMBus transfer. + * + * The argument type is a pointer to struct i2c_smbus_ioctl_data. + */ +#define I2C_SMBUS 0x720 + +/** @} */ + +/** + * @brief Argument type for I2C_SMBUS IO control call. + */ +struct i2c_smbus_ioctl_data { + uint8_t read_write; + uint8_t command; + uint32_t size; + union i2c_smbus_data *data; +}; + +/** + * @brief Argument type for I2C_RDWR IO control call. + */ +struct i2c_rdwr_ioctl_data { + struct i2c_msg *msgs; + uint32_t nmsgs; +}; + +/** + * @brief Maximum count of messages for one IO control call. + */ +#define I2C_RDRW_IOCTL_MAX_MSGS 42 + +/** @} */ + +#endif /* _UAPI_LINUX_I2C_DEV_H */ diff --git a/cpukit/dev/include/linux/i2c.h b/cpukit/dev/include/linux/i2c.h new file mode 100644 index 0000000000..eacacd7087 --- /dev/null +++ b/cpukit/dev/include/linux/i2c.h @@ -0,0 +1,274 @@ +/** + * @file + * + * @brief RTEMS Port of Linux I2C API + * + * @ingroup I2CLinux + */ + +/* + * Copyright (c) 2014 embedded brains GmbH. All rights reserved. + * + * embedded brains GmbH + * Dornierstr. 4 + * 82178 Puchheim + * Germany + * + * + * The license and distribution terms for this file may be + * found in the file LICENSE in this distribution or at + * http://www.rtems.org/license/LICENSE. + */ + +#ifndef _UAPI_LINUX_I2C_H +#define _UAPI_LINUX_I2C_H + +#include + +/** + * @defgroup I2CLinux Linux I2C User-Space API + * + * @ingroup I2C + * + * @brief RTEMS port of Linux I2C user-space API. + * + * Additional documentation is available through the Linux sources, see + * + * - /usr/src/linux/include/uapi/linux/i2c.h, + * - /usr/src/linux/include/uapi/linux/i2c-dev.h, and + * - /usr/src/linux/Documentation/i2c. + * + * @{ + */ + +/** + * @name I2C Message Flags + * + * @{ + */ + +/** + * @brief I2C message flag to indicate a 10-bit address. + * + * The controller must support this as indicated by the I2C_FUNC_10BIT_ADDR + * functionality. + * + * @see i2c_msg. + */ +#define I2C_M_TEN 0x0010 + +/** + * @brief I2C message flag to indicate a read transfer (from slave to master). + * + * @see i2c_msg. + */ +#define I2C_M_RD 0x0001 + +/** + * @brief I2C message flag to signal a stop condition even if this is not the + * last message. + * + * The controller must support this as indicated by the + * @ref I2C_FUNC_PROTOCOL_MANGLING functionality. + * + * @see i2c_msg. + */ +#define I2C_M_STOP 0x8000 + +/** + * @brief I2C message flag to omit start condition and slave address. + * + * The controller must support this as indicated by the + * @ref I2C_FUNC_NOSTART functionality. + * + * @see i2c_msg. + */ +#define I2C_M_NOSTART 0x4000 + +/** + * @brief I2C message flag to reverse the direction flag. + * + * The controller must support this as indicated by the + * @ref I2C_FUNC_PROTOCOL_MANGLING functionality. + * + * @see i2c_msg. + */ +#define I2C_M_REV_DIR_ADDR 0x2000 + +/** + * @brief I2C message flag to ignore a non-acknowledge. + * + * The controller must support this as indicated by the + * @ref I2C_FUNC_PROTOCOL_MANGLING functionality. + * + * @see i2c_msg. + */ +#define I2C_M_IGNORE_NAK 0x1000 + +/** + * @brief I2C message flag to omit a master acknowledge/non-acknowledge in a + * read transfer. + * + * The controller must support this as indicated by the + * @ref I2C_FUNC_PROTOCOL_MANGLING functionality. + * + * @see i2c_msg. + */ +#define I2C_M_NO_RD_ACK 0x0800 + +/** + * @brief I2C message flag to indicate that the message data length is the + * first received byte. + * + * The message data buffer must be large enough to store up to 32 bytes, the + * initial length byte and the SMBus PEC (if used). Initialize the message + * length to one. The message length is incremented by the count of received + * data bytes. + * + * @see i2c_msg. + */ +#define I2C_M_RECV_LEN 0x0400 + +/** @} */ + +/** + * @brief I2C transfer message. + */ +struct i2c_msg { + /** + * @brief The slave address. + * + * In case the @ref I2C_M_TEN flag is set, then this is a 10-bit address, + * otherwise it is a 7-bit address. + */ + uint16_t addr; + + /** + * @brief The message flags. + * + * Valid flags are + * - @ref I2C_M_TEN, + * - @ref I2C_M_RD, + * - @ref I2C_M_STOP, + * - @ref I2C_M_NOSTART, + * - @ref I2C_M_REV_DIR_ADDR, + * - @ref I2C_M_IGNORE_NAK, + * - @ref I2C_M_NO_RD_ACK, and + * - @ref I2C_M_RECV_LEN. + */ + uint16_t flags; + + /** + * @brief The message data length in bytes. + */ + uint16_t len; + + /** + * @brief Pointer to the message data. + */ + uint8_t *buf; +}; + +/** + * @name I2C Controller Functionality + * + * @{ + */ + +#define I2C_FUNC_I2C 0x00000001 +#define I2C_FUNC_10BIT_ADDR 0x00000002 +#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 +#define I2C_FUNC_SMBUS_PEC 0x00000008 +#define I2C_FUNC_NOSTART 0x00000010 +#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 +#define I2C_FUNC_SMBUS_QUICK 0x00010000 +#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000 +#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000 +#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000 +#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000 +#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000 +#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000 +#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000 +#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000 +#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000 +#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 +#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 + +#define I2C_FUNC_SMBUS_BYTE \ + (I2C_FUNC_SMBUS_READ_BYTE | I2C_FUNC_SMBUS_WRITE_BYTE) + +#define I2C_FUNC_SMBUS_BYTE_DATA \ + (I2C_FUNC_SMBUS_READ_BYTE_DATA | I2C_FUNC_SMBUS_WRITE_BYTE_DATA) + +#define I2C_FUNC_SMBUS_WORD_DATA \ + (I2C_FUNC_SMBUS_READ_WORD_DATA | I2C_FUNC_SMBUS_WRITE_WORD_DATA) + +#define I2C_FUNC_SMBUS_BLOCK_DATA \ + (I2C_FUNC_SMBUS_READ_BLOCK_DATA | I2C_FUNC_SMBUS_WRITE_BLOCK_DATA) + +#define I2C_FUNC_SMBUS_I2C_BLOCK \ + (I2C_FUNC_SMBUS_READ_I2C_BLOCK | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK) + +#define I2C_FUNC_SMBUS_EMUL \ + (I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE | I2C_FUNC_SMBUS_BYTE_DATA \ + | I2C_FUNC_SMBUS_WORD_DATA | I2C_FUNC_SMBUS_PROC_CALL \ + | I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | I2C_FUNC_SMBUS_I2C_BLOCK \ + | I2C_FUNC_SMBUS_PEC) + +/** @} */ + +/** + * @brief Maximum SMBus data block count. + */ +#define I2C_SMBUS_BLOCK_MAX 32 + +/** + * @brief SMBus data. + */ +union i2c_smbus_data { + uint8_t byte; + uint16_t word; + uint8_t block[I2C_SMBUS_BLOCK_MAX + 2]; +}; + +/** + * @name SMBus Transfer Read and Write Markers + * + * @{ + */ + +#define I2C_SMBUS_READ 1 + +#define I2C_SMBUS_WRITE 0 + +/** @} */ + +/** + * @name SMBus Transaction Types + * + * @{ + */ + +#define I2C_SMBUS_QUICK 0 + +#define I2C_SMBUS_BYTE 1 + +#define I2C_SMBUS_BYTE_DATA 2 + +#define I2C_SMBUS_WORD_DATA 3 + +#define I2C_SMBUS_PROC_CALL 4 + +#define I2C_SMBUS_BLOCK_DATA 5 + +#define I2C_SMBUS_I2C_BLOCK_BROKEN 6 + +#define I2C_SMBUS_BLOCK_PROC_CALL 7 + +#define I2C_SMBUS_I2C_BLOCK_DATA 8 + +/** @} */ + +/** @} */ + +#endif /* _UAPI_LINUX_I2C_H */ diff --git a/cpukit/dev/preinstall.am b/cpukit/dev/preinstall.am new file mode 100644 index 0000000000..a17d606c2f --- /dev/null +++ b/cpukit/dev/preinstall.am @@ -0,0 +1,33 @@ +## Automatically generated by ampolish3 - Do not edit + +if AMPOLISH3 +$(srcdir)/preinstall.am: Makefile.am + $(AMPOLISH3) $(srcdir)/Makefile.am > $(srcdir)/preinstall.am +endif + +PREINSTALL_DIRS = +DISTCLEANFILES = $(PREINSTALL_DIRS) + +all-am: $(PREINSTALL_FILES) + +PREINSTALL_FILES = +CLEANFILES = $(PREINSTALL_FILES) + +$(PROJECT_INCLUDE)/dev/$(dirstamp): + @$(MKDIR_P) $(PROJECT_INCLUDE)/dev + @: > $(PROJECT_INCLUDE)/dev/$(dirstamp) +PREINSTALL_DIRS += $(PROJECT_INCLUDE)/dev/$(dirstamp) + +$(PROJECT_INCLUDE)/linux/$(dirstamp): + @$(MKDIR_P) $(PROJECT_INCLUDE)/linux + @: > $(PROJECT_INCLUDE)/linux/$(dirstamp) +PREINSTALL_DIRS += $(PROJECT_INCLUDE)/linux/$(dirstamp) + +$(PROJECT_INCLUDE)/linux/i2c.h: include/linux/i2c.h $(PROJECT_INCLUDE)/linux/$(dirstamp) + $(INSTALL_DATA) $< $(PROJECT_INCLUDE)/linux/i2c.h +PREINSTALL_FILES += $(PROJECT_INCLUDE)/linux/i2c.h + +$(PROJECT_INCLUDE)/linux/i2c-dev.h: include/linux/i2c-dev.h $(PROJECT_INCLUDE)/linux/$(dirstamp) + $(INSTALL_DATA) $< $(PROJECT_INCLUDE)/linux/i2c-dev.h +PREINSTALL_FILES += $(PROJECT_INCLUDE)/linux/i2c-dev.h + -- cgit v1.2.3