Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 | /** * @file * * @brief Public APIs for the I2C drivers. */ /* * Copyright (c) 2015 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ #ifndef ZEPHYR_INCLUDE_DRIVERS_I2C_H_ #define ZEPHYR_INCLUDE_DRIVERS_I2C_H_ /** * @brief I2C Interface * @defgroup i2c_interface I2C Interface * @ingroup io_interfaces * @{ */ #include <zephyr/types.h> #include <device.h> #ifdef __cplusplus extern "C" { #endif /* * The following #defines are used to configure the I2C controller. */ /** I2C Standard Speed */ #define I2C_SPEED_STANDARD (0x1U) /** I2C Fast Speed */ #define I2C_SPEED_FAST (0x2U) /** I2C Fast Plus Speed */ #define I2C_SPEED_FAST_PLUS (0x3U) /** I2C High Speed */ #define I2C_SPEED_HIGH (0x4U) /** I2C Ultra Fast Speed */ #define I2C_SPEED_ULTRA (0x5U) #define I2C_SPEED_SHIFT (1U) #define I2C_SPEED_SET(speed) (((speed) << I2C_SPEED_SHIFT) \ & I2C_SPEED_MASK) #define I2C_SPEED_MASK (0x7U << I2C_SPEED_SHIFT) /* 3 bits */ #define I2C_SPEED_GET(cfg) (((cfg) & I2C_SPEED_MASK) \ >> I2C_SPEED_SHIFT) /** Use 10-bit addressing. DEPRECATED - Use I2C_MSG_ADDR_10_BITS instead. */ #define I2C_ADDR_10_BITS BIT(0) /** Controller to act as Master. */ #define I2C_MODE_MASTER BIT(4) /* * The following #defines are used to configure the I2C slave device */ /** Slave device responds to 10-bit addressing. */ #define I2C_SLAVE_FLAGS_ADDR_10_BITS BIT(0) /* * I2C_MSG_* are I2C Message flags. */ /** Write message to I2C bus. */ #define I2C_MSG_WRITE (0U << 0U) /** Read message from I2C bus. */ #define I2C_MSG_READ BIT(0) /** @cond INTERNAL_HIDDEN */ #define I2C_MSG_RW_MASK BIT(0) /** @endcond */ /** Send STOP after this message. */ #define I2C_MSG_STOP BIT(1) /** RESTART I2C transaction for this message. * * @note Not all I2C drivers have or require explicit support for this * feature. Some drivers require this be present on a read message * that follows a write, or vice-versa. Some drivers will merge * adjacent fragments into a single transaction using this flag; some * will not. */ #define I2C_MSG_RESTART BIT(2) /** Use 10-bit addressing for this message. * * @note Not all SoC I2C implementations support this feature. */ #define I2C_MSG_ADDR_10_BITS BIT(3) /** * @brief One I2C Message. * * This defines one I2C message to transact on the I2C bus. * * @note Some of the configurations supported by this API may not be * supported by specific SoC I2C hardware implementations, in * particular features related to bus transactions intended to read or * write data from different buffers within a single transaction. * Invocations of i2c_transfer() may not indicate an error when an * unsupported configuration is encountered. In some cases drivers * will generate separate transactions for each message fragment, with * or without presence of @ref I2C_MSG_RESTART in #flags. */ struct i2c_msg { /** Data buffer in bytes */ u8_t *buf; /** Length of buffer in bytes */ u32_t len; /** Flags for this message */ u8_t flags; }; /** * @cond INTERNAL_HIDDEN * * These are for internal use only, so skip these in * public documentation. */ struct i2c_slave_config; typedef int (*i2c_slave_write_requested_cb_t)( struct i2c_slave_config *config); typedef int (*i2c_slave_read_requested_cb_t)( struct i2c_slave_config *config, u8_t *val); typedef int (*i2c_slave_write_received_cb_t)( struct i2c_slave_config *config, u8_t val); typedef int (*i2c_slave_read_processed_cb_t)( struct i2c_slave_config *config, u8_t *val); typedef int (*i2c_slave_stop_cb_t)(struct i2c_slave_config *config); struct i2c_slave_callbacks { /** callback function being called when write is requested */ i2c_slave_write_requested_cb_t write_requested; /** callback function being called when read is requested */ i2c_slave_read_requested_cb_t read_requested; /** callback function being called when byte has been received */ i2c_slave_write_received_cb_t write_received; /** callback function being called when byte has been sent */ i2c_slave_read_processed_cb_t read_processed; /** callback function being called when stop occurs on the bus */ i2c_slave_stop_cb_t stop; }; struct i2c_slave_config { /** Private, do not modify */ sys_snode_t node; /** Flags for the slave device defined by I2C_SLAVE_FLAGS_* constants */ u8_t flags; /** Address for this slave device */ u16_t address; /** Callback functions */ const struct i2c_slave_callbacks *callbacks; }; typedef int (*i2c_api_configure_t)(struct device *dev, u32_t dev_config); typedef int (*i2c_api_full_io_t)(struct device *dev, struct i2c_msg *msgs, u8_t num_msgs, u16_t addr); typedef int (*i2c_api_slave_register_t)(struct device *dev, struct i2c_slave_config *cfg); typedef int (*i2c_api_slave_unregister_t)(struct device *dev, struct i2c_slave_config *cfg); struct i2c_driver_api { i2c_api_configure_t configure; i2c_api_full_io_t transfer; i2c_api_slave_register_t slave_register; i2c_api_slave_unregister_t slave_unregister; }; typedef int (*i2c_slave_api_register_t)(struct device *dev); typedef int (*i2c_slave_api_unregister_t)(struct device *dev); struct i2c_slave_driver_api { i2c_slave_api_register_t driver_register; i2c_slave_api_unregister_t driver_unregister; }; /** * @endcond */ /** * @brief Configure operation of a host controller. * * @param dev Pointer to the device structure for the driver instance. * @param dev_config Bit-packed 32-bit value to the device runtime configuration * for the I2C controller. * * @retval 0 If successful. * @retval -EIO General input / output error, failed to configure device. */ __syscall int i2c_configure(struct device *dev, u32_t dev_config); static inline int z_impl_i2c_configure(struct device *dev, u32_t dev_config) { const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->driver_api; return api->configure(dev, dev_config); } /** * @brief Perform data transfer to another I2C device. * * This routine provides a generic interface to perform data transfer * to another I2C device synchronously. Use i2c_read()/i2c_write() * for simple read or write. * * The array of message @a msgs must not be NULL. The number of * message @a num_msgs may be zero,in which case no transfer occurs. * * @note Not all scatter/gather transactions can be supported by all * drivers. As an example, a gather write (multiple consecutive * `i2c_msg` buffers all configured for `I2C_MSG_WRITE`) may be packed * into a single transaction by some drivers, but others may emit each * fragment as a distinct write transaction, which will not produce * the same behavior. See the documentation of `struct i2c_msg` for * limitations on support for multi-message bus transactions. * * @param dev Pointer to the device structure for the driver instance. * @param msgs Array of messages to transfer. * @param num_msgs Number of messages to transfer. * @param addr Address of the I2C target device. * * @retval 0 If successful. * @retval -EIO General input / output error. */ __syscall int i2c_transfer(struct device *dev, struct i2c_msg *msgs, u8_t num_msgs, u16_t addr); static inline int z_impl_i2c_transfer(struct device *dev, struct i2c_msg *msgs, u8_t num_msgs, u16_t addr) { const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->driver_api; return api->transfer(dev, msgs, num_msgs, addr); } /** * @brief Registers the provided config as Slave device * * Enable I2C slave mode for the 'dev' I2C bus driver using the provided * 'config' struct containing the functions and parameters to send bus * events. The I2C slave will be registered at the address provided as 'address' * struct member. Addressing mode - 7 or 10 bit - depends on the 'flags' * struct member. Any I2C bus events related to the slave mode will be passed * onto I2C slave device driver via a set of callback functions provided in * the 'callbacks' struct member. * * Most of the existing hardware allows simultaneous support for master * and slave mode. This is however not guaranteed. * * @param dev Pointer to the device structure for the driver instance. * @param cfg Config struct with functions and parameters used by the I2C driver * to send bus events * * @retval 0 Is successful * @retval -EINVAL If parameters are invalid * @retval -EIO General input / output error. * @retval -ENOTSUP If slave mode is not supported */ __syscall int i2c_slave_register(struct device *dev, struct i2c_slave_config *cfg); static inline int z_impl_i2c_slave_register(struct device *dev, struct i2c_slave_config *cfg) { const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->driver_api; if (api->slave_register == NULL) { return -ENOTSUP; } return api->slave_register(dev, cfg); } /** * @brief Unregisters the provided config as Slave device * * This routine disables I2C slave mode for the 'dev' I2C bus driver using * the provided 'config' struct containing the functions and parameters * to send bus events. * * @param dev Pointer to the device structure for the driver instance. * @param cfg Config struct with functions and parameters used by the I2C driver * to send bus events * * @retval 0 Is successful * @retval -EINVAL If parameters are invalid * @retval -ENOTSUP If slave mode is not supported */ __syscall int i2c_slave_unregister(struct device *dev, struct i2c_slave_config *cfg); static inline int z_impl_i2c_slave_unregister(struct device *dev, struct i2c_slave_config *cfg) { const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->driver_api; if (api->slave_unregister == NULL) { return -ENOTSUP; } return api->slave_unregister(dev, cfg); } /** * @brief Instructs the I2C Slave device to register itself to the I2C Controller * * This routine instructs the I2C Slave device to register itself to the I2C * Controller. * * @param dev Pointer to the device structure for the driver instance. * * @retval 0 Is successful * @retval -EINVAL If parameters are invalid * @retval -EIO General input / output error. */ __syscall int i2c_slave_driver_register(struct device *dev); static inline int z_impl_i2c_slave_driver_register(struct device *dev) { const struct i2c_slave_driver_api *api = (const struct i2c_slave_driver_api *)dev->driver_api; return api->driver_register(dev); } /** * @brief Instructs the I2C Slave device to unregister itself from the I2C * Controller * * This routine instructs the I2C Slave device to unregister itself from the I2C * Controller. * * @param dev Pointer to the device structure for the driver instance. * * @retval 0 Is successful * @retval -EINVAL If parameters are invalid */ __syscall int i2c_slave_driver_unregister(struct device *dev); static inline int z_impl_i2c_slave_driver_unregister(struct device *dev) { const struct i2c_slave_driver_api *api = (const struct i2c_slave_driver_api *)dev->driver_api; return api->driver_unregister(dev); } /* * Derived i2c APIs -- all implemented in terms of i2c_transfer() */ /** * @brief Write a set amount of data to an I2C device. * * This routine writes a set amount of data synchronously. * * @param dev Pointer to the device structure for the driver instance. * @param buf Memory pool from which the data is transferred. * @param num_bytes Number of bytes to write. * @param addr Address to the target I2C device for writing. * * @retval 0 If successful. * @retval -EIO General input / output error. */ static inline int i2c_write(struct device *dev, const u8_t *buf, u32_t num_bytes, u16_t addr) { struct i2c_msg msg; msg.buf = (u8_t *)buf; msg.len = num_bytes; msg.flags = I2C_MSG_WRITE | I2C_MSG_STOP; return i2c_transfer(dev, &msg, 1, addr); } /** * @brief Read a set amount of data from an I2C device. * * This routine reads a set amount of data synchronously. * * @param dev Pointer to the device structure for the driver instance. * @param buf Memory pool that stores the retrieved data. * @param num_bytes Number of bytes to read. * @param addr Address of the I2C device being read. * * @retval 0 If successful. * @retval -EIO General input / output error. */ static inline int i2c_read(struct device *dev, u8_t *buf, u32_t num_bytes, u16_t addr) { struct i2c_msg msg; msg.buf = buf; msg.len = num_bytes; msg.flags = I2C_MSG_READ | I2C_MSG_STOP; return i2c_transfer(dev, &msg, 1, addr); } /** * @brief Write then read data from an I2C device. * * This supports the common operation "this is what I want", "now give * it to me" transaction pair through a combined write-then-read bus * transaction. * * @param dev Pointer to the device structure for the driver instance * @param addr Address of the I2C device * @param write_buf Pointer to the data to be written * @param num_write Number of bytes to write * @param read_buf Pointer to storage for read data * @param num_read Number of bytes to read * * @retval 0 if successful * @retval negative on error. */ static inline int i2c_write_read(struct device *dev, u16_t addr, const void *write_buf, size_t num_write, void *read_buf, size_t num_read) { struct i2c_msg msg[2]; msg[0].buf = (u8_t *)write_buf; msg[0].len = num_write; msg[0].flags = I2C_MSG_WRITE; msg[1].buf = (u8_t *)read_buf; msg[1].len = num_read; msg[1].flags = I2C_MSG_RESTART | I2C_MSG_READ | I2C_MSG_STOP; return i2c_transfer(dev, msg, 2, addr); } /** * @brief Read multiple bytes from an internal address of an I2C device. * * This routine reads multiple bytes from an internal address of an * I2C device synchronously. * * Instances of this may be replaced by i2c_write_read(). * @param dev Pointer to the device structure for the driver instance. * @param dev_addr Address of the I2C device for reading. * @param start_addr Internal address from which the data is being read. * @param buf Memory pool that stores the retrieved data. * @param num_bytes Number of bytes being read. * * @retval 0 If successful. * @retval -EIO General input / output error. */ static inline int i2c_burst_read(struct device *dev, u16_t dev_addr, u8_t start_addr, u8_t *buf, u32_t num_bytes) { return i2c_write_read(dev, dev_addr, &start_addr, sizeof(start_addr), buf, num_bytes); } /** * @brief Write multiple bytes to an internal address of an I2C device. * * This routine writes multiple bytes to an internal address of an * I2C device synchronously. * * @warning The combined write synthesized by this API may not be * supported on all I2C devices. Uses of this API may be made more * portable by replacing them with calls to i2c_write() passing a * buffer containing the combined address and data. * * @param dev Pointer to the device structure for the driver instance. * @param dev_addr Address of the I2C device for writing. * @param start_addr Internal address to which the data is being written. * @param buf Memory pool from which the data is transferred. * @param num_bytes Number of bytes being written. * * @retval 0 If successful. * @retval -EIO General input / output error. */ static inline int i2c_burst_write(struct device *dev, u16_t dev_addr, u8_t start_addr, const u8_t *buf, u32_t num_bytes) { struct i2c_msg msg[2]; msg[0].buf = &start_addr; msg[0].len = 1U; msg[0].flags = I2C_MSG_WRITE; msg[1].buf = (u8_t *)buf; msg[1].len = num_bytes; msg[1].flags = I2C_MSG_WRITE | I2C_MSG_STOP; return i2c_transfer(dev, msg, 2, dev_addr); } /** * @brief Read internal register of an I2C device. * * This routine reads the value of an 8-bit internal register of an I2C * device synchronously. * * @param dev Pointer to the device structure for the driver instance. * @param dev_addr Address of the I2C device for reading. * @param reg_addr Address of the internal register being read. * @param value Memory pool that stores the retrieved register value. * * @retval 0 If successful. * @retval -EIO General input / output error. */ static inline int i2c_reg_read_byte(struct device *dev, u16_t dev_addr, u8_t reg_addr, u8_t *value) { return i2c_write_read(dev, dev_addr, ®_addr, sizeof(reg_addr), value, sizeof(*value)); } /** * @brief Write internal register of an I2C device. * * This routine writes a value to an 8-bit internal register of an I2C * device synchronously. * * @note This function internally combines the register and value into * a single bus transaction. * * @param dev Pointer to the device structure for the driver instance. * @param dev_addr Address of the I2C device for writing. * @param reg_addr Address of the internal register being written. * @param value Value to be written to internal register. * * @retval 0 If successful. * @retval -EIO General input / output error. */ static inline int i2c_reg_write_byte(struct device *dev, u16_t dev_addr, u8_t reg_addr, u8_t value) { u8_t tx_buf[2] = {reg_addr, value}; return i2c_write(dev, tx_buf, 2, dev_addr); } /** * @brief Update internal register of an I2C device. * * This routine updates the value of a set of bits from an 8-bit internal * register of an I2C device synchronously. * * @note If the calculated new register value matches the value that * was read this function will not generate a write operation. * * @param dev Pointer to the device structure for the driver instance. * @param dev_addr Address of the I2C device for updating. * @param reg_addr Address of the internal register being updated. * @param mask Bitmask for updating internal register. * @param value Value for updating internal register. * * @retval 0 If successful. * @retval -EIO General input / output error. */ static inline int i2c_reg_update_byte(struct device *dev, u8_t dev_addr, u8_t reg_addr, u8_t mask, u8_t value) { u8_t old_value, new_value; int rc; rc = i2c_reg_read_byte(dev, dev_addr, reg_addr, &old_value); if (rc != 0) { return rc; } new_value = (old_value & ~mask) | (value & mask); if (new_value == old_value) { return 0; } return i2c_reg_write_byte(dev, dev_addr, reg_addr, new_value); } struct i2c_client_config { char *i2c_master; u16_t i2c_addr; }; #define I2C_DECLARE_CLIENT_CONFIG struct i2c_client_config i2c_client #define I2C_CLIENT(_master, _addr) \ .i2c_client = { \ .i2c_master = (_master), \ .i2c_addr = (_addr), \ } #define I2C_GET_MASTER(_conf) ((_conf)->i2c_client.i2c_master) #define I2C_GET_ADDR(_conf) ((_conf)->i2c_client.i2c_addr) #ifdef __cplusplus } #endif /** * @} */ #include <syscalls/i2c.h> #endif /* ZEPHYR_INCLUDE_DRIVERS_I2C_H_ */ |