Documentation: Fix compilation warnings
This commit is contained in:
parent
1b87c86619
commit
c961edbe6c
@ -24,9 +24,10 @@ We need ``genromfs`` to build simulators(NON GUI).
|
||||
|
||||
$ git clone https://github.com/chexum/genromfs.git
|
||||
$ cd genromfs
|
||||
$ make
|
||||
$ make
|
||||
$ make install
|
||||
Now Copy the built `genromfs` `exec` to /opt/local/bin
|
||||
|
||||
Now Copy the built `genromfs` `exec` to /opt/local/bin.
|
||||
|
||||
For GUI Applications we need X11 Libraries, libx11 can also be built using Homebrew or by Installing XQuartz.
|
||||
|
||||
|
@ -19,8 +19,8 @@ Features
|
||||
* Onboard 1.28-inch 240 x 240 resolution, 65K RGB IPS LCD display for clear color pictures
|
||||
* Lithium battery recharge/discharge header, suitable for mobile devices
|
||||
* All GPIOs are adapted through 1.27 pitch female headers
|
||||
(There are 30 pins in total, but some pins have been connected to the internal circuit,
|
||||
you need to pay attention when multiplexing, please refer to the wiki for details)
|
||||
(There are 30 pins in total, but some pins have been connected to the internal circuit,
|
||||
you need to pay attention when multiplexing, please refer to the wiki for details)
|
||||
* USB 1.1 with device and host support
|
||||
* Low-power sleep and dormant modes
|
||||
* Drag-and-drop programming using mass storage over USB
|
||||
|
@ -10,7 +10,7 @@ same files and functions for all of those series and therefore they can be merge
|
||||
named as SAM V7.
|
||||
|
||||
Supported MCUs
|
||||
=============
|
||||
==============
|
||||
|
||||
The following list includes MCUs from SAM x7 series and indicates whether they are supported in NuttX
|
||||
|
||||
@ -305,8 +305,9 @@ Supported Boards
|
||||
|
||||
For board documentation please refer to ``board/arm/samv7`` section to separate README files.
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
..
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
boards/*/*
|
||||
boards/*/*
|
||||
|
@ -1,6 +1,6 @@
|
||||
====================
|
||||
========================
|
||||
PolarFire SoC Icicle Kit
|
||||
====================
|
||||
========================
|
||||
|
||||
.. list-table::
|
||||
:align: center
|
||||
|
@ -1,6 +1,6 @@
|
||||
===========================
|
||||
======================================
|
||||
Microchip PolarFire® SoC FPGA's (MPFS)
|
||||
===========================
|
||||
======================================
|
||||
|
||||
RV64 64-bit RISC-V multiprocessor-based Microcontroller Subsystem
|
||||
(MPFS025T, MPFS095T, MPFS160T, MPFS250T, MPFS460T)
|
||||
|
@ -9,18 +9,19 @@ interface with are also identified in ``include/nuttx/arch.h`` or
|
||||
in other header files.
|
||||
|
||||
.. toctree::
|
||||
conventions.rst
|
||||
addrenv.rst
|
||||
app_vs_os.rst
|
||||
arch.rst
|
||||
board.rst
|
||||
time_clock.rst
|
||||
mutex.rst
|
||||
wqueue.rst
|
||||
addrenv.rst
|
||||
nuttx.rst
|
||||
app_vs_os.rst
|
||||
smp.rst
|
||||
shm.rst
|
||||
paging.rst
|
||||
led.rst
|
||||
conventions.rst
|
||||
iob.rst
|
||||
led.rst
|
||||
mutex.rst
|
||||
nat.rst
|
||||
notifier.rst
|
||||
nuttx.rst
|
||||
paging.rst
|
||||
shm.rst
|
||||
smp.rst
|
||||
time_clock.rst
|
||||
wqueue.rst
|
||||
|
@ -7,23 +7,22 @@ nxmutex
|
||||
|
||||
Use `nxmutex` prefixed api to protect resources. In fact, nxmutex is implemented
|
||||
based on nxsem. The difference between nxmutex and nxsem is that nxmutex supports
|
||||
priority inheritance by default, nxsem do not support priority inheritance by default
|
||||
priority inheritance by default, nxsem do not support priority inheritance by default.
|
||||
|
||||
usually usage:
|
||||
Typical Usage
|
||||
-------------
|
||||
|
||||
call nxmutex_init() for driver, when two tasks will use driver, their timing will be:
|
||||
=============== ================
|
||||
taskA taskB
|
||||
================ ================
|
||||
nxmutex_lock() nxmutex_lock()
|
||||
================ ================
|
||||
get lock running wait for lock
|
||||
================= ================
|
||||
nxmutex_unlock() wait for lock
|
||||
================= ================
|
||||
get lock running
|
||||
================= ================
|
||||
nxmutex_unlock()
|
||||
Call nxmutex_init() for driver, when two tasks will use driver, their timing will be:
|
||||
|
||||
================= ====================
|
||||
taskA taskB
|
||||
================= ====================
|
||||
nxmutex_lock() nxmutex_lock()
|
||||
get lock running wait for lock
|
||||
nxmutex_unlock() wait for lock
|
||||
- get lock running
|
||||
- nxmutex_unlock()
|
||||
================= ====================
|
||||
|
||||
Priority inheritance
|
||||
====================
|
||||
@ -98,7 +97,7 @@ Api description
|
||||
:return:
|
||||
Zero(OK) is returned on success.A negated errno value is returned on failure.
|
||||
Possible returned errors:
|
||||
|
||||
|
||||
EINVAL - Invalid attempt to lock the mutex
|
||||
EAGAIN - The mutex is not available.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
===========
|
||||
==============
|
||||
Notifier Chain
|
||||
===========
|
||||
==============
|
||||
|
||||
NuttX provides a callback list mechanism called *Notifier Chain*.
|
||||
Notifier chain is essentially a list of callbacks used at certain times,
|
||||
@ -10,35 +10,35 @@ such as system asserting, powering off and restarting.
|
||||
for some implementation differences.
|
||||
|
||||
Classes of Notifier Chain
|
||||
======================
|
||||
=========================
|
||||
|
||||
There are currently two different classes of notifier.
|
||||
|
||||
Atomic notifier chains
|
||||
-------------------------------
|
||||
----------------------
|
||||
|
||||
Atomic notifier chains: Chain callbacks run in interrupt/atomic context.
|
||||
In Nuttx, callouts are allowed to block(In Linux, callouts in atomic
|
||||
notifier chain are not allowed to block). One example of an Atomic notifier
|
||||
chain is turning off FPU when asserting.
|
||||
|
||||
Blocking notifier chains:
|
||||
------------------------------
|
||||
Blocking notifier chains
|
||||
------------------------
|
||||
|
||||
Blocking notifier chains: Chain callbacks run in process context.
|
||||
Callouts are allowed to block. One example of a blocking notifier chain
|
||||
is when an orderly powering off is needed.
|
||||
is when an orderly powering off is needed.
|
||||
|
||||
Common Notifier Chain Interfaces
|
||||
============================
|
||||
================================
|
||||
|
||||
Notifier Block Types
|
||||
--------------------------
|
||||
--------------------
|
||||
|
||||
- ``struct notifier_block``. Defines one notifier callback entry.
|
||||
|
||||
Notifier Chain Interfaces
|
||||
---------------------
|
||||
-------------------------
|
||||
|
||||
.. c:function:: void panic_notifier_chain_register(FAR struct notifier_block *nb)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user