OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/drivers/i2c/i2c_dw.h

125 lines
3.0 KiB
C
Raw Normal View History

i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
/* dw_i2c.h - header for Design Ware I2C operations */
/*
* Copyright (c) 2015 Intel Corporation
*
license: Replace Apache boilerplate with SPDX tag Replace the existing Apache 2.0 boilerplate header with an SPDX tag throughout the zephyr code tree. This patch was generated via a script run over the master branch. Also updated doc/porting/application.rst that had a dependency on line numbers in a literal include. Manually updated subsys/logging/sys_log.c that had a malformed header in the original file. Also cleanup several cases that already had a SPDX tag and we either got a duplicate or missed updating. Jira: ZEP-1457 Change-Id: I6131a1d4ee0e58f5b938300c2d2fc77d2e69572c Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-01-19 09:01:01 +08:00
* SPDX-License-Identifier: Apache-2.0
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
*/
i2c: rename DW_I2C -> I2C_DW This driver naming is an exception which compared with all other drivers we have. To keep things consistent the configuration options and variables are renamed to <type>_<name>. Change-Id: Ib95aa09630a507848f78d8f2c28706b545eed06d Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-09-20 10:54:53 +08:00
#ifndef __DRIVERS_I2C_DW_H
#define __DRIVERS_I2C_DW_H
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
#include <i2c.h>
#include <stdbool.h>
i2c: Adding support for PCI enabled dw i2c controller Since such controller is found on Quark x1000 (Galileo, ...), it will need to get configured and/or enabled through PCI. Change-Id: I16d00364edcb17653eaaf073e87b4e5850de7299 Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2015-08-31 17:00:42 +08:00
#ifdef CONFIG_PCI
#include <pci/pci.h>
#include <pci/pci_mgr.h>
#endif /* CONFIG_PCI */
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
c++: Add extern "C" { } block to header files Adds extern "C" { } blocks to header files so that they can be safely used by C++ source files. Change-Id: Ia4db0c36a5dac5d3de351184a297d2af0df64532 Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-01-23 01:38:49 +08:00
#ifdef __cplusplus
extern "C" {
#endif
i2c: rename DW_I2C -> I2C_DW This driver naming is an exception which compared with all other drivers we have. To keep things consistent the configuration options and variables are renamed to <type>_<name>. Change-Id: Ib95aa09630a507848f78d8f2c28706b545eed06d Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-09-20 10:54:53 +08:00
#define I2C_DW_MAGIC_KEY 0x44570140
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
typedef void (*i2c_isr_cb_t)(struct device *port);
#define IC_ACTIVITY (1 << 0)
#define IC_ENABLE_BIT (1 << 0)
/* dev->state values from IC_DATA_CMD Data transfer mode settings (bit 8) */
i2c: rename DW_I2C -> I2C_DW This driver naming is an exception which compared with all other drivers we have. To keep things consistent the configuration options and variables are renamed to <type>_<name>. Change-Id: Ib95aa09630a507848f78d8f2c28706b545eed06d Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-09-20 10:54:53 +08:00
#define I2C_DW_STATE_READY (0)
#define I2C_DW_CMD_SEND (1 << 0)
#define I2C_DW_CMD_RECV (1 << 1)
#define I2C_DW_CMD_ERROR (1 << 2)
i2c: dw: re-organize transfer related code () Re-organize the steps involved in data transfer, according to the datasheet's flowchart. () Extract the common code for transfer initialization and put it into its own function. () i2c_write() and i2c_polling_write() are now using the common data sending function. Change-Id: Ieb90253ee10ddceb3b5d05b258e7fc6253d18729 Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2015-10-07 02:29:30 +08:00
#define I2C_DW_BUSY (1 << 3)
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
#define DW_ENABLE_TX_INT_I2C_MASTER (DW_INTR_STAT_TX_OVER | \
DW_INTR_STAT_TX_EMPTY | \
DW_INTR_STAT_TX_ABRT | \
DW_INTR_STAT_STOP_DET)
#define DW_ENABLE_RX_INT_I2C_MASTER (DW_INTR_STAT_RX_UNDER | \
DW_INTR_STAT_RX_OVER | \
DW_INTR_STAT_RX_FULL | \
DW_INTR_STAT_STOP_DET)
#define DW_ENABLE_TX_INT_I2C_SLAVE (DW_INTR_STAT_RD_REQ | \
DW_INTR_STAT_TX_ABRT | \
DW_INTR_STAT_STOP_DET)
#define DW_ENABLE_RX_INT_I2C_SLAVE (DW_INTR_STAT_RX_FULL | \
DW_INTR_STAT_STOP_DET)
#define DW_DISABLE_ALL_I2C_INT 0x00000000
/* IC_CON Low count and high count default values */
/* TODO verify values for high and fast speed */
drivers: i2c: rename I2C_CLOCK_SPEED Kconfig option I2C_CLOCK_SPEED Kconfig option is DW driver specific. It does not define I2C interface speed but rather the I2C DW module clock speed. It is confusing for a user of any other I2C driver than DW. This patch renames this option to I2C_DW_CLOCK_SPEED and makes it visible only for DW I2C driver. Change-Id: I97f57332fd5cca644eabdef0968a0b2174b885ff Signed-off-by: Piotr Mienkowski <piotr.mienkowski@gmail.com>
2017-04-08 06:29:49 +08:00
#define I2C_STD_HCNT (CONFIG_I2C_DW_CLOCK_SPEED * 4)
#define I2C_STD_LCNT (CONFIG_I2C_DW_CLOCK_SPEED * 5)
#define I2C_FS_HCNT ((CONFIG_I2C_DW_CLOCK_SPEED * 6) / 8)
#define I2C_FS_LCNT ((CONFIG_I2C_DW_CLOCK_SPEED * 7) / 8)
#define I2C_HS_HCNT ((CONFIG_I2C_DW_CLOCK_SPEED * 6) / 8)
#define I2C_HS_LCNT ((CONFIG_I2C_DW_CLOCK_SPEED * 7) / 8)
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
/*
* DesignWare speed values don't directly translate from the Zephyr speed
* selections in include/i2c.h so here we do a little translation
*/
i2c: rename DW_I2C -> I2C_DW This driver naming is an exception which compared with all other drivers we have. To keep things consistent the configuration options and variables are renamed to <type>_<name>. Change-Id: Ib95aa09630a507848f78d8f2c28706b545eed06d Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-09-20 10:54:53 +08:00
#define I2C_DW_SPEED_STANDARD 0x1
#define I2C_DW_SPEED_FAST 0x2
#define I2C_DW_SPEED_FAST_PLUS 0x2
#define I2C_DW_SPEED_HIGH 0x3
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
/*
* These values have been randomly selected. It would be good to test different
* watermark levels for performance capabilities
*/
i2c: rename DW_I2C -> I2C_DW This driver naming is an exception which compared with all other drivers we have. To keep things consistent the configuration options and variables are renamed to <type>_<name>. Change-Id: Ib95aa09630a507848f78d8f2c28706b545eed06d Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-09-20 10:54:53 +08:00
#define I2C_DW_TX_WATERMARK 2
#define I2C_DW_RX_WATERMARK 7
#define I2C_DW_FIFO_DEPTH 16
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
i2c: naming functions to follow naming convention Many of the i2c functions continue to exist in a format of <IP>_<interface> and will now follow the <interface>_<IP>_ naming convention. Change-Id: Ic7ec879105f5c06f0213f8d771b3811253c49658 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-09-24 06:23:53 +08:00
struct i2c_dw_rom_config {
drivers: convert to using newly introduced integer sized types Convert code to use u{8,16,32,64}_t and s{8,16,32,64}_t instead of C99 integer types. Jira: ZEP-2051 Change-Id: I08f51e2bfd475f6245771c1bd2df7ffc744c48c4 Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-04-21 23:03:20 +08:00
u32_t irq_num;
u32_t interrupt_mask;
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
i2c_isr_cb_t config_func;
i2c: dw: add shared IRQ support On some platforms (e.g. Galileo), the I2C controller is on PCI bus, which shares IRQ with other devices (GPIO on Galileo). This patch adds support for utilizing shared IRQ. Change-Id: Id4e4714aed37c2893d0ffe9ed1e4edaabb338121 Signed-off-by: Daniel Leung <daniel.leung@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-09-29 06:11:42 +08:00
drivers: i2c: rename IRQ SHARED/DIRECT Kconfig options I2C_SHARED_IRQ, I2C_0_IRQ_SHARED, I2C_0_IRQ_DIRECT Kconfig options are DW driver specific. Its presence is confusing for a user of any other I2C driver than DW. This patch renames these options to include DW string and makes it visible only for DW I2C driver. This is a similar implementation to that used by ETH DW Ethernet driver. Change-Id: I795506f9b103c028a22317df9ad632dce5cd1343 Signed-off-by: Piotr Mienkowski <piotr.mienkowski@gmail.com>
2017-04-08 08:39:57 +08:00
#ifdef CONFIG_I2C_DW_SHARED_IRQ
i2c: dw: add shared IRQ support On some platforms (e.g. Galileo), the I2C controller is on PCI bus, which shares IRQ with other devices (GPIO on Galileo). This patch adds support for utilizing shared IRQ. Change-Id: Id4e4714aed37c2893d0ffe9ed1e4edaabb338121 Signed-off-by: Daniel Leung <daniel.leung@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-09-29 06:11:42 +08:00
char *shared_irq_dev_name;
drivers: i2c: rename IRQ SHARED/DIRECT Kconfig options I2C_SHARED_IRQ, I2C_0_IRQ_SHARED, I2C_0_IRQ_DIRECT Kconfig options are DW driver specific. Its presence is confusing for a user of any other I2C driver than DW. This patch renames these options to include DW string and makes it visible only for DW I2C driver. This is a similar implementation to that used by ETH DW Ethernet driver. Change-Id: I795506f9b103c028a22317df9ad632dce5cd1343 Signed-off-by: Piotr Mienkowski <piotr.mienkowski@gmail.com>
2017-04-08 08:39:57 +08:00
#endif /* CONFIG_I2C_DW_SHARED_IRQ */
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
};
i2c: naming functions to follow naming convention Many of the i2c functions continue to exist in a format of <IP>_<interface> and will now follow the <interface>_<IP>_ naming convention. Change-Id: Ic7ec879105f5c06f0213f8d771b3811253c49658 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-09-24 06:23:53 +08:00
struct i2c_dw_dev_config {
drivers: convert to using newly introduced integer sized types Convert code to use u{8,16,32,64}_t and s{8,16,32,64}_t instead of C99 integer types. Jira: ZEP-2051 Change-Id: I08f51e2bfd475f6245771c1bd2df7ffc744c48c4 Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-04-21 23:03:20 +08:00
u32_t base_address;
drivers: i2c: replace device sync APIs with semaphores Device sync APIs are actually wrappers for semaphores. Let's replace them with semaphores. Jira: ZEP-1411 Change-Id: I5662057222aec54f02db9d9cdcd7f4f006c6c530 Signed-off-by: Baohong Liu <baohong.liu@intel.com>
2016-12-07 08:57:41 +08:00
struct k_sem device_sync_sem;
drivers: i2c: remove usage of bitfield access for cfg Cleanup I2C drivers to not use bitfield access for config information and instead use accessor macros that use shifts & masks. This is cleanup towards removing the bitfield access in the future. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-09-14 00:31:00 +08:00
u32_t app_config;
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
i2c: make i2c_transfer() really generic Make the i2c_transfer() to transact messages through the I2C bus. It is useful for I2C storage devices, as now we can send one message containing the destination byte/block address, then send the data in another message. There is no need to construct one continuous data buffer to send both address and data anymore. The drivers and sample apps have been updated to utilize updated API when appropriate. For i2c_dw, only master mode has been updated. Slave mode will be updated once we can adequately test it. Change-Id: I0a811d60567367817fcc8d15f5454e5c933722e2 Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2016-01-12 07:35:39 +08:00
drivers: convert to using newly introduced integer sized types Convert code to use u{8,16,32,64}_t and s{8,16,32,64}_t instead of C99 integer types. Jira: ZEP-2051 Change-Id: I08f51e2bfd475f6245771c1bd2df7ffc744c48c4 Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-04-21 23:03:20 +08:00
u8_t *xfr_buf;
u32_t xfr_len;
u32_t rx_pending;
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
drivers: convert to using newly introduced integer sized types Convert code to use u{8,16,32,64}_t and s{8,16,32,64}_t instead of C99 integer types. Jira: ZEP-2051 Change-Id: I08f51e2bfd475f6245771c1bd2df7ffc744c48c4 Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-04-21 23:03:20 +08:00
u16_t hcnt;
u16_t lcnt;
struct packing Looking at all structs as to where we can pack them a little better, and calling out the padding/stride at the end for future expansion. Change-Id: I4a651092e950dd3d915af9fa0ee0d7d59803e58f Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-01-29 04:53:34 +08:00
drivers: convert to using newly introduced integer sized types Convert code to use u{8,16,32,64}_t and s{8,16,32,64}_t instead of C99 integer types. Jira: ZEP-2051 Change-Id: I08f51e2bfd475f6245771c1bd2df7ffc744c48c4 Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-04-21 23:03:20 +08:00
volatile u8_t state; /* last direction of transfer */
u8_t request_bytes;
u8_t xfr_flags;
struct packing Looking at all structs as to where we can pack them a little better, and calling out the padding/stride at the end for future expansion. Change-Id: I4a651092e950dd3d915af9fa0ee0d7d59803e58f Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-01-29 04:53:34 +08:00
bool support_hs_mode;
i2c/dw: Move RW objects in config_info to driver_data PCI enumeration modifies pci_dev, base_addaress at driver initialization therefore this objects move from config_info to driver_data in preparation for config_info becoming const.. We drop code that attempts to update irq_num based on PCI enumeration because the interrupt found by PCI enumeration must always be the same as the statically configured IRQ number. Change-Id: Id5af682dac112ec6dc6e4aa14b655e0047972d38 Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
2016-10-11 05:59:51 +08:00
#ifdef CONFIG_PCI
struct pci_dev_info pci_dev;
#endif /* CONFIG_PCI */
i2c: import of Synopsis DesignWare I2C Initial import of Synopsis DesignWare I2C driver functionality for the Zephyr Project. This import has been tested for host master control. While it does contain the code to work as a host slave, this code has not yet been completely tested and validated. Change-Id: I3df0214f6e3b6798f7dad4819d09c3ec5998e508 Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
2015-08-27 05:56:43 +08:00
};
c++: Add extern "C" { } block to header files Adds extern "C" { } blocks to header files so that they can be safely used by C++ source files. Change-Id: Ia4db0c36a5dac5d3de351184a297d2af0df64532 Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-01-23 01:38:49 +08:00
#ifdef __cplusplus
}
#endif
i2c: rename DW_I2C -> I2C_DW This driver naming is an exception which compared with all other drivers we have. To keep things consistent the configuration options and variables are renamed to <type>_<name>. Change-Id: Ib95aa09630a507848f78d8f2c28706b545eed06d Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-09-20 10:54:53 +08:00
#endif /* __DRIVERS_I2C_DW_H */