diff --git a/docs/renesas-ra/general.rst b/docs/renesas-ra/general.rst new file mode 100644 index 0000000000..c8eea53f8b --- /dev/null +++ b/docs/renesas-ra/general.rst @@ -0,0 +1,42 @@ +.. _renesas-ra_general: + +General information about Renesas RA port +========================================= + +Overview +-------- + +The renesas-ra port supports boards powered by Renesas Electronics's +the flexible Renesas Advanced (RA) 32-bit microcontrollers (MCUs) family, +industry-leading 32-bit MCUs with the Arm® Cortex®-M33, -M23 and -M4 +processor cores and PSA certification. + +The ported hardware functionalities are Pin, SPI, I2C, UART and RTC at this present. +Other hardware functionalities such as Timer, PWM, USB, CAN and WDT are not implemented yet. + +The following boards are officially supported. + +* RA4M1-CLICKER + +For the manual and other references for the board and RA Family MCU, please refer to the web page: `EK-RA4M1 CLICKER `_ + +* EK-RA6M2 + +For the manual and other references for the board and RA Family MCU, please refer to the web page: `EK-RA6M2 `_ + +The following boards are unofficially supported. + +* EK-RA4M1 + +For the manual and other references for the board and RA Family MCU, please refer to the web page: `EK-RA4M1 `_ + +* EK-RA4W1 + +For the manual and other references for the board and RA Family MCU, please refer to the web page: `EK-RA4W1 `_ + +* EK-RA6M1 + +For the manual and other references for the board and RA Family MCU, please refer to the web page: `EK-RA6M1 `_ + +For more information, please visit the web page: ``_ + diff --git a/docs/renesas-ra/img/ek_ra6m2_board.jpg b/docs/renesas-ra/img/ek_ra6m2_board.jpg new file mode 100644 index 0000000000..85c0305a1c Binary files /dev/null and b/docs/renesas-ra/img/ek_ra6m2_board.jpg differ diff --git a/docs/renesas-ra/quickref.rst b/docs/renesas-ra/quickref.rst new file mode 100644 index 0000000000..23ffab50eb --- /dev/null +++ b/docs/renesas-ra/quickref.rst @@ -0,0 +1,415 @@ +.. _renesas-ra_quickref: + +Quick reference for the Renesas RA +================================== + +.. image:: img/ek_ra6m2_board.jpg + :alt: Renesas Evaluation Kit for RA6M2 MCU Group + :width: 640px + +The Renesas EK-RA6M2 board. + +Below is a quick reference for the Renesas RA boards. If it is your first time +working with this board, it may be useful to get an overview of the microcontroller and the board: + +.. toctree:: + :maxdepth: 1 + + general.rst + tutorial/index.rst + +Installing MicroPython +---------------------- + +See the corresponding section of tutorial: :ref:`renesas-ra_intro`. It also includes a troubleshooting subsection. + +General board control +--------------------- + +The MicroPython REPL is accessed via the USB serial port. Tab-completion is useful to find out what methods an object has. Paste mode (ctrl-E) is useful to paste a large slab of Python code into the REPL. Some of features are not implemented for Renesas RA boards yet, please refer to the tutorial for more details. + +The :mod:`machine` module:: + + import machine + + machine.freq() # get the current frequency of the CPU + + +Following functions are supported:: + + machine.freq() + machine.reset() + machine.soft_reset() + machine.unique_id() + +Following functions are not supported at the present:: + + machine.reset_cause() + machine.bootloader([value]) + machine.disable_irq() + machine.enable_irq(state) + machine.freq([hz]) + machine.idle() + machine.sleep() + machine.lightsleep() + machine.lightsleep([time_ms]) + machine.deepsleep() + machine.deepsleep([time_ms]) + machine.wake_reason() + machine.time_pulse_us(pin, pulse_level, timeout_us=1000000,/) + machine.bitstream(pin, encoding, timing, data, /) + machine.rng() + + +Delay and timing +---------------- + +Use the :mod:`time