Did the same for the rest of busio

Author: evaherrada

shared-bindings/busio/I2C.c

@@ -36,33 +36,35 @@
 #include "py/runtime.h"
 #include "supervisor/shared/translate.h"
 
-//|class I2C:
-//|""".. currentmodule:: busio
+//| class I2C:
+//|     """.. currentmodule:: busio
 //|
-//|:class:`I2C` --- Two wire serial protocol
-//|------------------------------------------"""
-//|def __init__(self, scl: microcontroller.Pin, sda: microcontroller.Pin, *, frequency: int = 400000, timeout: int = 255):
-//|"""I2C is a two-wire protocol for communicating between devices.  At the
-//|physical level it consists of 2 wires: SCL and SDA, the clock and data
-//|lines respectively.
+//|     :class:`I2C` --- Two wire serial protocol
+//|     ------------------------------------------"""
 //|
-//|.. seealso:: Using this class directly requires careful lock management.
-//|Instead, use :class:`~adafruit_bus_device.i2c_device.I2CDevice` to
-//|manage locks.
+//|     def __init__(self, scl: microcontroller.Pin, sda: microcontroller.Pin, *, frequency: int = 400000, timeout: int = 255):
 //|
-//|.. seealso:: Using this class to directly read registers requires manual
-//|bit unpacking. Instead, use an existing driver or make one with
-//|:ref:`Register <register-module-reference>` data descriptors.
+//|         """I2C is a two-wire protocol for communicating between devices.  At the
+//|         physical level it consists of 2 wires: SCL and SDA, the clock and data
+//|         lines respectively.
 //|
-//|:param ~microcontroller.Pin scl: The clock pin
-//|:param ~microcontroller.Pin sda: The data pin
-//|:param int frequency: The clock frequency in Hertz
-//|:param int timeout: The maximum clock stretching timeut - (used only for bitbangio.I2C; ignored for busio.I2C)
+//|         .. seealso:: Using this class directly requires careful lock management.
+//|             Instead, use :class:`~adafruit_bus_device.i2c_device.I2CDevice` to
+//|             manage locks.
 //|
-//|.. note:: On the nRF52840, only one I2C object may be created,
-//|except on the Circuit Playground Bluefruit, which allows two,
-//|one for the onboard accelerometer, and one for offboard use."""
-//|...
+//|         .. seealso:: Using this class to directly read registers requires manual
+//|             bit unpacking. Instead, use an existing driver or make one with
+//|             :ref:`Register <register-module-reference>` data descriptors.
+//|
+//|         :param ~microcontroller.Pin scl: The clock pin
+//|         :param ~microcontroller.Pin sda: The data pin
+//|         :param int frequency: The clock frequency in Hertz
+//|         :param int timeout: The maximum clock stretching timeut - (used only for bitbangio.I2C; ignored for busio.I2C)
+//|
+//|         .. note:: On the nRF52840, only one I2C object may be created,
+//|            except on the Circuit Playground Bluefruit, which allows two,
+//|            one for the onboard accelerometer, and one for offboard use."""
+//|         ...
 STATIC mp_obj_t busio_i2c_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     busio_i2c_obj_t *self = m_new_obj(busio_i2c_obj_t);
     self->base.type = &busio_i2c_type;
@@ -83,9 +85,9 @@ STATIC mp_obj_t busio_i2c_make_new(const mp_obj_type_t *type, size_t n_args, con
     return (mp_obj_t)self;
 }
 
-//|def deinit(self, ) -> Any:
-//|"""Releases control of the underlying hardware so other classes can use it."""
-//|...
+//| def deinit(self, ) -> Any:
+//|     """Releases control of the underlying hardware so other classes can use it."""
+//|     ...
 STATIC mp_obj_t busio_i2c_obj_deinit(mp_obj_t self_in) {
     busio_i2c_obj_t *self = MP_OBJ_TO_PTR(self_in);
     common_hal_busio_i2c_deinit(self);
@@ -99,15 +101,15 @@ STATIC void check_for_deinit(busio_i2c_obj_t *self) {
     }
 }
 
-//|def __enter__(self, ) -> Any:
-//|"""No-op used in Context Managers."""
-//|...
+//| def __enter__(self, ) -> Any:
+//|     """No-op used in Context Managers."""
+//|     ...
 //  Provided by context manager helper.
 
-//|def __exit__(self, ) -> Any:
-//|"""Automatically deinitializes the hardware on context exit. See
-//|:ref:`lifetime-and-contextmanagers` for more info."""
-//|...
+//| def __exit__(self, ) -> Any:
+//|     """Automatically deinitializes the hardware on context exit. See
+//|     :ref:`lifetime-and-contextmanagers` for more info."""
+//|     ...
 STATIC mp_obj_t busio_i2c_obj___exit__(size_t n_args, const mp_obj_t *args) {
     (void)n_args;
     common_hal_busio_i2c_deinit(args[0]);
@@ -122,13 +124,14 @@ static void check_lock(busio_i2c_obj_t *self) {
     }
 }
 
-//|def scan(self, ) -> Any:
-//|"""Scan all I2C addresses between 0x08 and 0x77 inclusive and return a
-//|list of those that respond.
+//| def scan(self, ) -> Any:
 //|
-//|:return: List of device ids on the I2C bus
-//|:rtype: list"""
-//|...
+//|      """Scan all I2C addresses between 0x08 and 0x77 inclusive and return a
+//|      list of those that respond.
+//|
+//|      :return: List of device ids on the I2C bus
+//|      :rtype: list"""
+//|      ...
 STATIC mp_obj_t busio_i2c_scan(mp_obj_t self_in) {
     busio_i2c_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -145,21 +148,22 @@ STATIC mp_obj_t busio_i2c_scan(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(busio_i2c_scan_obj, busio_i2c_scan);
 
-//|def try_lock(self, ) -> Any:
-//|"""Attempts to grab the I2C lock. Returns True on success.
-//|:return: True when lock has been grabbed
-//|:rtype: bool"""
-//|...
+//| def try_lock(self, ) -> Any:
+//|     """Attempts to grab the I2C lock. Returns True on success.
+//|
+//|     :return: True when lock has been grabbed
+//|     :rtype: bool"""
+//|     ...
 STATIC mp_obj_t busio_i2c_obj_try_lock(mp_obj_t self_in) {
     busio_i2c_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
     return mp_obj_new_bool(common_hal_busio_i2c_try_lock(self));
 }
 MP_DEFINE_CONST_FUN_OBJ_1(busio_i2c_try_lock_obj, busio_i2c_obj_try_lock);
 
-//|def unlock(self, ) -> Any:
-//|"""Releases the I2C lock."""
-//|...
+//| def unlock(self, ) -> Any:
+//|     """Releases the I2C lock."""
+//|     ...
 STATIC mp_obj_t busio_i2c_obj_unlock(mp_obj_t self_in) {
     busio_i2c_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -168,20 +172,20 @@ STATIC mp_obj_t busio_i2c_obj_unlock(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(busio_i2c_unlock_obj, busio_i2c_obj_unlock);
 
-//|def readfrom_into(self, address: int, buffer: bytearray, *, start: int = 0, end: int = None) -> Any:
-//|"""Read into ``buffer`` from the slave specified by ``address``.
-//|The number of bytes read will be the length of ``buffer``.
-//|At least one byte must be read.
+//| def readfrom_into(self, address: int, buffer: bytearray, *, start: int = 0, end: int = None) -> Any:
+//|      """Read into ``buffer`` from the slave specified by ``address``.
+//|      The number of bytes read will be the length of ``buffer``.
+//|      At least one byte must be read.
 //|
-//|If ``start`` or ``end`` is provided, then the buffer will be sliced
-//|as if ``buffer[start:end]``. This will not cause an allocation like
-//|``buf[start:end]`` will so it saves memory.
+//|      If ``start`` or ``end`` is provided, then the buffer will be sliced
+//|      as if ``buffer[start:end]``. This will not cause an allocation like
+//|      ``buf[start:end]`` will so it saves memory.
 //|
-//|:param int address: 7-bit device address
-//|:param bytearray buffer: buffer to write into
-//|:param int start: Index to start writing at
-//|:param int end: Index to write up to but not include. Defaults to ``len(buffer)``"""
-//|...
+//|      :param int address: 7-bit device address
+//|      :param bytearray buffer: buffer to write into
+//|      :param int start: Index to start writing at
+//|      :param int end: Index to write up to but not include. Defaults to ``len(buffer)``"""
+//|      ...
 // Shared arg parsing for readfrom_into and writeto_then_readfrom.
 STATIC void readfrom(busio_i2c_obj_t *self, mp_int_t address, mp_obj_t buffer, int32_t start, mp_int_t end) {
     mp_buffer_info_t bufinfo;
@@ -219,26 +223,26 @@ STATIC mp_obj_t busio_i2c_readfrom_into(size_t n_args, const mp_obj_t *pos_args,
 }
 MP_DEFINE_CONST_FUN_OBJ_KW(busio_i2c_readfrom_into_obj, 3, busio_i2c_readfrom_into);
 
-//|def writeto(self, address: int, buffer: bytearray, *, start: int = 0, end: int = None, stop: bool = True) -> Any:
-//|"""Write the bytes from ``buffer`` to the slave specified by ``address``.
-//|Transmits a stop bit when stop is True. Setting stop=False is deprecated and stop will be
-//|removed in CircuitPython 6.x. Use `writeto_then_readfrom` when needing a write, no stop and
-//|repeated start before a read.
+//| def writeto(self, address: int, buffer: bytearray, *, start: int = 0, end: int = None, stop: bool = True) -> Any:
+//|      """Write the bytes from ``buffer`` to the slave specified by ``address``.
+//|      Transmits a stop bit when stop is True. Setting stop=False is deprecated and stop will be
+//|      removed in CircuitPython 6.x. Use `writeto_then_readfrom` when needing a write, no stop and
+//|      repeated start before a read.
 //|
-//|If ``start`` or ``end`` is provided, then the buffer will be sliced
-//|as if ``buffer[start:end]``. This will not cause an allocation like
-//|``buffer[start:end]`` will so it saves memory.
+//|      If ``start`` or ``end`` is provided, then the buffer will be sliced
+//|      as if ``buffer[start:end]``. This will not cause an allocation like
+//|      ``buffer[start:end]`` will so it saves memory.
 //|
-//|Writing a buffer or slice of length zero is permitted, as it can be used
-//|to poll for the existence of a device.
+//|      Writing a buffer or slice of length zero is permitted, as it can be used
+//|      to poll for the existence of a device.
 //|
-//|:param int address: 7-bit device address
-//|:param bytearray buffer: buffer containing the bytes to write
-//|:param int start: Index to start writing from
-//|:param int end: Index to read up to but not include. Defaults to ``len(buffer)``
-//|:param bool stop: If true, output an I2C stop condition after the buffer is written.
-//|Deprecated. Will be removed in 6.x and act as stop=True."""
-//|...
+//|      :param int address: 7-bit device address
+//|      :param bytearray buffer: buffer containing the bytes to write
+//|      :param int start: Index to start writing from
+//|      :param int end: Index to read up to but not include. Defaults to ``len(buffer)``
+//|      :param bool stop: If true, output an I2C stop condition after the buffer is written.
+//|                        Deprecated. Will be removed in 6.x and act as stop=True."""
+//|      ...
 // Shared arg parsing for writeto and writeto_then_readfrom.
 STATIC void writeto(busio_i2c_obj_t *self, mp_int_t address, mp_obj_t buffer, int32_t start, mp_int_t end, bool stop) {
     // get the buffer to write the data from
@@ -277,23 +281,23 @@ STATIC mp_obj_t busio_i2c_writeto(size_t n_args, const mp_obj_t *pos_args, mp_ma
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_KW(busio_i2c_writeto_obj, 1, busio_i2c_writeto);
 
-//|def writeto_then_readfrom(self, address: int, out_buffer: bytearray, in_buffer: bytearray, *, out_start: int = 0, out_end: int = None, in_start: int = 0, in_end: int = None) -> Any:
-//|"""Write the bytes from ``out_buffer`` to the slave specified by ``address``, generate no stop
-//|bit, generate a repeated start and read into ``in_buffer``. ``out_buffer`` and
-//|``in_buffer`` can be the same buffer because they are used sequentially.
+//| def writeto_then_readfrom(self, address: int, out_buffer: bytearray, in_buffer: bytearray, *, out_start: int = 0, out_end: int = None, in_start: int = 0, in_end: int = None) -> Any:
+//|      """Write the bytes from ``out_buffer`` to the slave specified by ``address``, generate no stop
+//|      bit, generate a repeated start and read into ``in_buffer``. ``out_buffer`` and
+//|      ``in_buffer`` can be the same buffer because they are used sequentially.
 //|
-//|If ``start`` or ``end`` is provided, then the corresponding buffer will be sliced
-//|as if ``buffer[start:end]``. This will not cause an allocation like ``buf[start:end]``
-//|will so it saves memory.
+//|      If ``start`` or ``end`` is provided, then the corresponding buffer will be sliced
+//|      as if ``buffer[start:end]``. This will not cause an allocation like ``buf[start:end]``
+//|      will so it saves memory.
 //|
-//|:param int address: 7-bit device address
-//|:param bytearray out_buffer: buffer containing the bytes to write
-//|:param bytearray in_buffer: buffer to write into
-//|:param int out_start: Index to start writing from
-//|:param int out_end: Index to read up to but not include. Defaults to ``len(buffer)``
-//|:param int in_start: Index to start writing at
-//|:param int in_end: Index to write up to but not include. Defaults to ``len(buffer)``"""
-//|...
+//|      :param int address: 7-bit device address
+//|      :param bytearray out_buffer: buffer containing the bytes to write
+//|      :param bytearray in_buffer: buffer to write into
+//|      :param int out_start: Index to start writing from
+//|      :param int out_end: Index to read up to but not include. Defaults to ``len(buffer)``
+//|      :param int in_start: Index to start writing at
+//|      :param int in_end: Index to write up to but not include. Defaults to ``len(buffer)``"""
+//|      ...
 STATIC mp_obj_t busio_i2c_writeto_then_readfrom(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_address, ARG_out_buffer, ARG_in_buffer, ARG_out_start, ARG_out_end, ARG_in_start, ARG_in_end };
     static const mp_arg_t allowed_args[] = {