1340 Commits

Author SHA1 Message Date
Kinsey Moore
24cce927ed user/zynqmp-rpu: Update boot suggestion
Change the development suggestion for booting the R5 since the R5 u-boot
is only minimally functional without significant development. This also
adds caveats when booting the R5 cores from the A53.
2024-02-26 11:10:02 -06:00
Chris Johns
204ac80935 sphinx: Use the pip installed sphinx-rtd-theme
- Remove the RTEMS version of the theme

- Use conf.py to specify our style sheet

- Depend on the jQuery contrib package for including jQuery

- Detect the theme is installed

Closes #4994
2024-02-21 07:44:36 -06:00
Kinsey Moore
bb7ddedf96 user/bsps/arm: Add documentation for ZynqMP R5 BSP
This adds basic user documentation for running RTEMS on the Cortex-R5
processor on Xilinx Zynq Ultrascale+ MPSoC chips.
2024-01-10 14:57:27 -06:00
Chris Johns
e4a0de61e2 user: Automatic version number fixes
Updates #4695
2023-12-20 08:05:52 +11:00
Chris Johns
e31a0b22fe sphinx/style: Fix building with the latest sphinx
Tested on sphinx 7.2, 6.1.3 AND 5.3.0

Closes #4980
2023-12-20 08:05:52 +11:00
Sebastian Huber
ddf2b03838 c-user: CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITY
Document CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITY.

Update #4961.
2023-12-19 08:30:54 +01:00
Sebastian Huber
ef49c4692b glossary: Add terms 2023-12-19 08:30:54 +01:00
Christian Mauderer
6744793931 bsps/imxrt: Document GPIO CS pins for LPSPI 2023-11-28 13:38:25 +01:00
Chris Johns
500ac0df65 user/hosts/macos: Update MacOS versions and using python.org 2023-11-23 11:05:24 +11:00
Andrew Butterfield
2c88912893 eng: Add formal verification chapter 2023-11-09 13:44:36 +01:00
Alex White
5da4bcda3b user/exe: Add MicroBlaze to Dynamic Loader architecture list 2023-10-10 16:40:18 -05:00
Sebastian Huber
68ece64ffc eng: Allow target attribute in build script items 2023-09-18 08:49:34 +02:00
Sebastian Huber
d8514c438c user: Fix typo 2023-09-13 12:08:59 +02:00
Joel Sherrill
7bd117cb00 Add Regulator documentation based on V1 functionality 2023-08-09 10:40:56 -05:00
Karel Gardas
ded73ef7c9 eng: add Apache License 2.0 restriction 2023-07-28 22:11:31 +02:00
Sebastian Huber
536f0e2b02 c-user: Clarify global construction 2023-07-28 10:16:03 +02:00
Joel Sherrill
fbcae10810 common/waf.py: Add option to check maximum Sphinx version
Updates #4928.
2023-07-25 15:20:22 -05:00
Joel Sherrill
13237ab34b layout.html: Revert patch forcing Spinx to >= 6.0
Unfortunately, updating past Sphinx 5.x results in unordered bullet
lists not formatting correctly as show in a screen capture attached
to #4928. Revert this patch until the issue is resolved and output
is reviewed for other potential issues.

    From: Utkarsh Verma <utkarsh@bitbanged.com>
    Date: Wed, 14 Jun 2023 05:36:26 +0000
    Subject: [PATCH] eng: Fix builds for newer Sphinx versions (>=7)

    The current Sphinx theme depends on the `style` parameter which got
    deprecated in v5.1 and finally got removed in v7. Now, the `styles` key
    should be preferred which is a list of stylesheets. This commit
    implements this change.

Updates #4915.
Updates #4928.
2023-07-25 15:20:12 -05:00
Sebastian Huber
6692946100 c-user: Link task entry and global construction 2023-07-25 07:36:09 +02:00
Christian Mauderer
929d0a9d41 user/bsps/imxrt: Add new BSP variant
Add information about the new i.MXRT1166 BSP. Rework some parts that
have been changed during or as preparation for that variant:

* The BSP now adapts to the Chip variant. It's no longer necessary to
  overwrite the PLL settings in an application.

* Improve documentation on how to adapt to different boards.

* Add Update the i.MXRT chapter so that it represents the new i.MXRT1166
  BSP.

* Add information about mcux-sdk and how to handle it.
2023-07-24 14:49:13 +02:00
Sebastian Huber
4b4a796d37 c-user: Add glossary terms for SPARC targets 2023-07-20 15:04:10 +02:00
Sebastian Huber
63a5c190b0 c-user: Fix typo
Updates #4772.
2023-07-20 15:04:10 +02:00
Sebastian Huber
be789ee60e c-user: Update copyright and use glossary terms
Updates #4772.
2023-07-20 11:27:35 +02:00
Zainab Olalekan
a0b958e0ee user/bsp-build: Fix typo in BSP set builder command
changed bsp to arch/bsp
2023-07-18 17:36:20 -05:00
Kinsey Moore
981ba2de41 c-user: Update references to rtems_task_wake_after
rtems_task_wake_after takes a parameter in terms of a count of clock
ticks and not a measure in a subunit of seconds. This updates
documentation to reflect that. This also makes obvious the caveat about
the first tick wait not being a whole tick and points the user at a
replacement for better accuracy.

Updates #4772
2023-07-06 13:55:37 -05:00
Sebastian Huber
bb19475be4 eng: Add guidelines for validation tests
Update #3717.
2023-06-26 17:16:02 +02:00
Stanley V. Paulauskas
17da9885bb README: Fixing spelling and grammar errors
Most of the mistakes were in the body text, which hindered only clarity.

One mistake was found in the Document Standard item 7, which would prevent
the provided code snippit from working.
2023-06-16 15:46:35 -05:00
Alex White
f820560ee9 user/microblaze: Document device tree support 2023-06-16 15:46:15 -05:00
Alex White
6478447d08 user/microblaze: Document QSPI NOR JFFS2 driver 2023-06-16 15:46:15 -05:00
Utkarsh Verma
4c87f9b594 eng: Fix builds for newer Sphinx versions (>=7)
The current Sphinx theme depends on the `style` parameter which got
deprecated in v5.1 and finally got removed in v7. Now, the `styles` key
should be preferred which is a list of stylesheets. This commit
implements this change.

Closes #4915
2023-06-14 15:45:56 +10:00
Sebastian Huber
bbb8b7aa81 Update company name
The embedded brains GmbH & Co. KG is the legal successor of embedded
brains GmbH.
2023-05-20 11:12:29 +02:00
Sebastian Huber
2e939ff735 eng: Add register block specification types
A register block may be used to specify the interface of devices which
contain registers associated with an integer address.  Register blocks
consist of register block members specified by the ``definition``
attribute.  Register block members are either instances of registers
specified by the ``registers`` attribute or instances of other register
blocks specified by links with the "register-block-include" link role.
Registers consists of bit fields.  The register block members are placed
into the address space of the device relative to the base address of the
register block.  Register member offests and the register block size are
specified in units of the address space granule.

Update #3715.
2023-05-19 07:35:57 +02:00
Sebastian Huber
e33eae15a7 c-user: Generate API type documentation
Close #4901.
2023-05-09 14:06:01 +02:00
Sebastian Huber
9c2498a728 eng: Add unspecified header file item type
Update #3715.
2023-05-09 14:00:52 +02:00
Sebastian Huber
2fecb7a025 eng: Make design group identifiers optional
Update #3715.
2023-05-05 10:40:34 +02:00
Sebastian Huber
63286a5f85 eng: Add an item type for not defined defines
This helps to deduce that a missing define in the software design is
intended.

Update #3715.
2023-05-05 10:38:53 +02:00
Sebastian Huber
9a5fb29377 eng: Remove ambiguous interface types
Use an item proxy instead.

Update #3715.
2023-05-05 10:38:53 +02:00
Sebastian Huber
8bc24e5f54 eng: Add proxy item type
Update #3715.
2023-05-05 10:38:51 +02:00
Sebastian Huber
2a5e59d34f eng: Add design target item type
Update #3715.
2023-05-04 15:53:16 +02:00
Sebastian Huber
c69046ef48 eng: Remove obsolete type listing
Update #3715.
2023-05-04 15:53:12 +02:00
Sebastian Huber
7158449cc5 eng: Update application configuration how-to
Change paths to be in line with the actual specification.  Fix group
membership link role.

Update #3715.
2023-05-04 15:53:12 +02:00
Sebastian Huber
77e8b566b7 eng: Add optional floating-point number type
Update #3715.
2023-05-04 15:52:43 +02:00
Sebastian Huber
98172bc9a4 eng: Use type refinement for validation method
Update #3715.
2023-05-04 15:51:36 +02:00
Sebastian Huber
c81a24418a eng: Add conditional build dependencies
Update #3715.
2023-05-04 15:51:32 +02:00
Sebastian Huber
5928d04c84 eng: Generalize external references
Use a common subtype for external references of interfaces and
requirements.  Add specializations for document and file references.

Update #3715.
2023-05-04 15:50:54 +02:00
Sebastian Huber
6dc190beea eng: Rework performance meansurement items
Use links to specify runtime performance limits in target-specific
items.  Clarify wording.

Update #3715.
2023-05-04 15:50:54 +02:00
Utkarsh Verma
6baa2d628b bsp-howto: Fix grammar and improve coherence. 2023-04-14 08:36:55 -06:00
Alan Cudmore
cbeaec94e1 docs/user: add docs for riscv/kendrytek210 BSP variant
This patch adds the documentation for building and running RTEMS on the Kendryte K210 RISC-V SoC.
The generic riscv introducion was re-arranged to list the multilib variants then the specific
hardware targets. In addition a couple of errors were fixed for the generic QEMU commands.

V2 corrected a typo, expanded K210 Console UART parameters, and addded a hyperlink to renode.io install
instructions.

V3 clarified the multilib variant description, clarified the multilib variant reference platform, and
corrected capitalization on SiFive.

V4 improves the instructions for running the K210 BSP on the Renode.io simulator.

V5 cleaned up the text to be no more than 80 characters per line.

V6 applied word wrap to paragraphs and replaced hard coded RTEMS major versions with macros.

Closes #4876
2023-04-11 16:03:27 -05:00
Joel Sherrill
1ac52ce798 user/bsps/bsps-riscv.rst: Revert v2 of patch 2023-04-11 16:03:24 -05:00
Alan Cudmore
e38a900842 docs/user: add docs for riscv/kendrytek210 BSP variant
This patch adds the documentation for building and running RTEMS on the Kendryte K210
RISC-V SoC. The generic riscv introducion was re-arranged to list the multilib variants
then the specific hardware targets. In addition a couple of errors were fixed for the
generic QEMU commands.

V2 corrected a typo, expanded K210 Console UART parameters, and addded a hyperlink
to renode.io install instructions.

Closes #4876
2023-04-11 13:28:23 -05:00