79 lines
3.3 KiB
C
79 lines
3.3 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2016 Scott Shawcroft
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
// Machine is the HAL for low-level, hardware accelerated functions. It is not
|
|
// meant to simplify APIs, its only meant to unify them so that other modules
|
|
// do not require port specific logic.
|
|
//
|
|
// This file includes externs for all functions a port should implement to
|
|
// support the machine module.
|
|
|
|
#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_BUSIO_I2C_H
|
|
#define MICROPY_INCLUDED_SHARED_BINDINGS_BUSIO_I2C_H
|
|
|
|
#include "py/obj.h"
|
|
|
|
#include "common-hal/microcontroller/Pin.h"
|
|
#include "common-hal/busio/I2C.h"
|
|
|
|
// Type object used in Python. Should be shared between ports.
|
|
extern const mp_obj_type_t busio_i2c_type;
|
|
|
|
// Initializes the hardware peripheral.
|
|
extern void common_hal_busio_i2c_construct(busio_i2c_obj_t *self,
|
|
const mcu_pin_obj_t *scl,
|
|
const mcu_pin_obj_t *sda,
|
|
uint32_t frequency,
|
|
uint32_t timeout);
|
|
|
|
extern void common_hal_busio_i2c_deinit(busio_i2c_obj_t *self);
|
|
extern bool common_hal_busio_i2c_deinited(busio_i2c_obj_t *self);
|
|
|
|
extern bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self);
|
|
extern bool common_hal_busio_i2c_has_lock(busio_i2c_obj_t *self);
|
|
extern void common_hal_busio_i2c_unlock(busio_i2c_obj_t *self);
|
|
|
|
// Probe the bus to see if a device acknowledges the given address.
|
|
extern bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr);
|
|
|
|
// Write to the device and return 0 on success or an appropriate error code from mperrno.h
|
|
extern uint8_t common_hal_busio_i2c_write(busio_i2c_obj_t *self, uint16_t address,
|
|
const uint8_t *data, size_t len);
|
|
|
|
// Reads memory of the i2c device picking up where it left off and return 0 on
|
|
// success or an appropriate error code from mperrno.h
|
|
extern uint8_t common_hal_busio_i2c_read(busio_i2c_obj_t *self, uint16_t address,
|
|
uint8_t *data, size_t len);
|
|
|
|
// Do a write and then a read in the same I2C transaction.
|
|
uint8_t common_hal_busio_i2c_write_read(busio_i2c_obj_t *self, uint16_t address,
|
|
uint8_t *out_data, size_t out_len, uint8_t *in_data, size_t in_len);
|
|
|
|
// This is used by the supervisor to claim I2C devices indefinitely.
|
|
extern void common_hal_busio_i2c_never_reset(busio_i2c_obj_t *self);
|
|
|
|
#endif // MICROPY_INCLUDED_SHARED_BINDINGS_BUSIO_I2C_H
|