mirror of
https://github.com/micropython/micropython.git
synced 2026-01-04 11:10:14 +01:00
This adds the ability to expose CPU-specific features/extensions to scripts when the `platform` module is compiled in, by implementing `platform.processor()`. Right now this is only available on bare-metal RV32 and RV64. Signed-off-by: Alessandro Gatti <a.gatti@frob.it>
47 lines
1.5 KiB
ReStructuredText
47 lines
1.5 KiB
ReStructuredText
:mod:`platform` -- access to underlying platform’s identifying data
|
||
===================================================================
|
||
|
||
.. module:: platform
|
||
:synopsis: access to underlying platform’s identifying data
|
||
|
||
|see_cpython_module| :mod:`python:platform`.
|
||
|
||
This module tries to retrieve as much platform-identifying data as possible. It
|
||
makes this information available via function APIs.
|
||
|
||
Functions
|
||
---------
|
||
|
||
.. function:: platform()
|
||
|
||
Returns a string identifying the underlying platform. This string is composed
|
||
of several substrings in the following order, delimited by dashes (``-``):
|
||
|
||
- the name of the platform system (e.g. Unix, Windows or MicroPython)
|
||
- the MicroPython version
|
||
- the architecture of the platform
|
||
- the version of the underlying platform
|
||
- the concatenation of the name of the libc that MicroPython is linked to
|
||
and its corresponding version.
|
||
|
||
For example, this could be
|
||
``"MicroPython-1.20.0-xtensa-IDFv4.2.4-with-newlib3.0.0"``.
|
||
|
||
.. function:: python_compiler()
|
||
|
||
Returns a string identifying the compiler used for compiling MicroPython.
|
||
|
||
.. function:: libc_ver()
|
||
|
||
Returns a tuple of strings *(lib, version)*, where *lib* is the name of the
|
||
libc that MicroPython is linked to, and *version* the corresponding version
|
||
of this libc.
|
||
|
||
.. function:: processor()
|
||
|
||
Returns a string with a detailed name of the processor, if one is available.
|
||
If no name for the processor is known, it will return an empty string
|
||
instead.
|
||
|
||
This is currently available only on RISC-V targets (both 32 and 64 bits).
|