1/*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2016 Damien P. George
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
26#ifndef MICROPY_INCLUDED_EXTMOD_MACHINE_I2C_H
27#define MICROPY_INCLUDED_EXTMOD_MACHINE_I2C_H
28
29#include "py/obj.h"
30#include "py/mphal.h"
31
32// Temporary support for legacy construction of SoftI2C via I2C type.
33#define MP_MACHINE_I2C_CHECK_FOR_LEGACY_SOFTI2C_CONSTRUCTION(n_args, n_kw, all_args) \
34 do { \
35 if (n_args == 0 || all_args[0] == MP_OBJ_NEW_SMALL_INT(-1)) { \
36 mp_print_str(MICROPY_ERROR_PRINTER, "Warning: I2C(-1, ...) is deprecated, use SoftI2C(...) instead\n"); \
37 if (n_args != 0) { \
38 --n_args; \
39 ++all_args; \
40 } \
41 return mp_machine_soft_i2c_type.make_new(&mp_machine_soft_i2c_type, n_args, n_kw, all_args); \
42 } \
43 } while (0)
44
45#define MP_MACHINE_I2C_FLAG_READ (0x01) // if not set then it's a write
46#define MP_MACHINE_I2C_FLAG_STOP (0x02)
47
48typedef struct _mp_machine_i2c_buf_t {
49 size_t len;
50 uint8_t *buf;
51} mp_machine_i2c_buf_t;
52
53// I2C protocol
54// - init must be non-NULL
55// - start/stop/read/write can be NULL, meaning operation is not supported
56// - transfer must be non-NULL
57// - transfer_single only needs to be set if transfer=mp_machine_i2c_transfer_adaptor
58typedef struct _mp_machine_i2c_p_t {
59 void (*init)(mp_obj_base_t *obj, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args);
60 int (*start)(mp_obj_base_t *obj);
61 int (*stop)(mp_obj_base_t *obj);
62 int (*read)(mp_obj_base_t *obj, uint8_t *dest, size_t len, bool nack);
63 int (*write)(mp_obj_base_t *obj, const uint8_t *src, size_t len);
64 int (*transfer)(mp_obj_base_t *obj, uint16_t addr, size_t n, mp_machine_i2c_buf_t *bufs, unsigned int flags);
65 int (*transfer_single)(mp_obj_base_t *obj, uint16_t addr, size_t len, uint8_t *buf, unsigned int flags);
66} mp_machine_i2c_p_t;
67
68typedef struct _mp_machine_soft_i2c_obj_t {
69 mp_obj_base_t base;
70 uint32_t us_delay;
71 uint32_t us_timeout;
72 mp_hal_pin_obj_t scl;
73 mp_hal_pin_obj_t sda;
74} mp_machine_soft_i2c_obj_t;
75
76extern const mp_obj_type_t mp_machine_soft_i2c_type;
77extern const mp_obj_dict_t mp_machine_i2c_locals_dict;
78
79int mp_machine_i2c_transfer_adaptor(mp_obj_base_t *self, uint16_t addr, size_t n, mp_machine_i2c_buf_t *bufs, unsigned int flags);
80int mp_machine_soft_i2c_transfer(mp_obj_base_t *self, uint16_t addr, size_t n, mp_machine_i2c_buf_t *bufs, unsigned int flags);
81
82#endif // MICROPY_INCLUDED_EXTMOD_MACHINE_I2C_H
83