diff --git a/bsps/arm/altera-cyclone-v/contrib/hwlib/README.txt b/bsps/arm/altera-cyclone-v/contrib/hwlib/README.md similarity index 100% rename from bsps/arm/altera-cyclone-v/contrib/hwlib/README.txt rename to bsps/arm/altera-cyclone-v/contrib/hwlib/README.md diff --git a/bsps/i386/pc386/console/GDB.HOWTO b/bsps/i386/pc386/console/README.md similarity index 97% rename from bsps/i386/pc386/console/GDB.HOWTO rename to bsps/i386/pc386/console/README.md index d5e0326781..79ae9ce35a 100644 --- a/bsps/i386/pc386/console/GDB.HOWTO +++ b/bsps/i386/pc386/console/README.md @@ -1,4 +1,5 @@ i386/pc386 GDB Stub +=================== The i386 GDB stub has been updated to use the libchip drivers for the NS16550. Make sure you have detect the device and you have added a console @@ -10,6 +11,7 @@ The pc386 BSP has boot command line options to manage GDB support. a) Find the minor number of the console device: +```c #include rtems_device_minor_number minor = 0; @@ -17,11 +19,13 @@ a) Find the minor number of the console device: if (console_find_console_entry("/dev/com1", strlen("/dev/com1") - 1, &minor) == NULL) error("driver not found\n"); +``` Note, this call is part of the private console API and may change. b) To start GDB stub, run this: +```c #include /* Init GDB glue */ @@ -41,7 +45,9 @@ b) To start GDB stub, run this: breakpoint(); c) To run use GDB: +``` +```shell $ i386-rtems4.12-gdb hello.exe GNU gdb (GDB) 7.11 Copyright (C) 2016 Free Software Foundation, Inc. @@ -70,6 +76,7 @@ c) To run use GDB: Breakpoint 1, Init (ignored=1269800) at init.c:29 29 { (gdb) +``` Pressing ^C works and if running the board should halt when GDB connects. @@ -77,8 +84,12 @@ e) Use ser2net to provide reomve access over a network to a board. Install the ser2net package and add a configuration for the port GDB connects to. For example: +```shell 0005:raw:0:/dev/cuaU5:115200 +``` Start ser2net running then connect GDB using: +```shell (gdb) target remote myhost:30005 +``` diff --git a/bsps/include/dev/clock/VERSION b/bsps/include/dev/clock/README.md similarity index 92% rename from bsps/include/dev/clock/VERSION rename to bsps/include/dev/clock/README.md index 1ccbe7c216..e4cd0411f8 100644 --- a/bsps/include/dev/clock/VERSION +++ b/bsps/include/dev/clock/README.md @@ -1,10 +1,14 @@ +Version +======= + The information in this file describes the source of bsps/include/dev/clock/xttcps_hw.h. Import from: -https://github.com/Xilinx/embeddedsw.git + https://github.com/Xilinx/embeddedsw.git +``` commit 5330a64c8efd14f0eef09befdbb8d3d738c33ec2 Refs: Author: Nicole Baze @@ -22,3 +26,4 @@ CommitDate: Fri Oct 7 10:26:16 2022 +0530 Signed-off-by: Nicole Baze Acked-by: Jesus De Haro +``` diff --git a/bsps/m68k/genmcf548x/mcdma/ReleaseNotes.txt b/bsps/m68k/genmcf548x/mcdma/README.md similarity index 92% rename from bsps/m68k/genmcf548x/mcdma/ReleaseNotes.txt rename to bsps/m68k/genmcf548x/mcdma/README.md index 12eb03cff9..8b905667e5 100644 --- a/bsps/m68k/genmcf548x/mcdma/ReleaseNotes.txt +++ b/bsps/m68k/genmcf548x/mcdma/README.md @@ -1,4 +1,6 @@ -Multi-channel DMA API Release Notes +Multi-channel DMA API +===================== +Release Notes Version 0.3 @@ -22,5 +24,3 @@ Version 0.1 (Initial release) Alpha version MCD_INCLUDE_EU functionality not supported. MCD_INCLUDE_JBIG not supported. - - diff --git a/bsps/mips/malta/STATUS b/bsps/mips/malta/README.md similarity index 97% rename from bsps/mips/malta/STATUS rename to bsps/mips/malta/README.md index 44e8f7cdc4..16a9162939 100644 --- a/bsps/mips/malta/STATUS +++ b/bsps/mips/malta/README.md @@ -1,3 +1,6 @@ +Status +====== + 17 Februrary 2011 XXX @@ -9,7 +12,7 @@ Anything not mentioned has not been touched at all and will most likely not be in the first release of the BSP. Working -======= +------- + Board initialization and shutdown + tty0 working polled + tty1 working polled (see note in issues) @@ -18,7 +21,7 @@ Working Issues -====== +------ + We have small hack to Qemu so reset will exit. This needs to be fixed to follow the PC386 Qemu model where a command line argument selects reset or exit on reset. @@ -31,7 +34,7 @@ Issues as the characters are polled out. TBD -=== +--- + Conversion to Programmable Interrupt Controller IRQ model using shared infrastructure + tty0 working interrupt driver diff --git a/bsps/powerpc/gen83xx/README.mpc8349eamds b/bsps/powerpc/gen83xx/README.md similarity index 51% rename from bsps/powerpc/gen83xx/README.mpc8349eamds rename to bsps/powerpc/gen83xx/README.md index 71be4b9eca..5422cb6479 100644 --- a/bsps/powerpc/gen83xx/README.mpc8349eamds +++ b/bsps/powerpc/gen83xx/README.md @@ -1,3 +1,6 @@ +gen83xx +======= +``` BSP NAME: gen83xx BOARD: Freescale MPC8349 board MPC8349EAMDS BUS: PCI (unused) @@ -7,9 +10,11 @@ COPROCESSORS: N/A MODE: 32 bit mode DEBUG MONITOR: U-Boot +``` PERIPHERALS -=========== +----------- +``` TIMERS: PPC internal Timebase register RESOLUTION: ??? SERIAL PORTS: 2 internal PSCs @@ -18,25 +23,59 @@ DMA: none VIDEO: none SCSI: none NETWORKING: 2xTSEC triple speed ethernet channels +``` DRIVER INFORMATION -================== +------------------ +``` CLOCK DRIVER: PPC internal IOSUPP DRIVER: N/A SHMSUPP: N/A TIMER DRIVER: PPC internal TTY DRIVER: PPC internal +``` STDIO -===== +----- +``` PORT: Console port 1 ELECTRICAL: na BAUD: 9600 BITS PER CHARACTER: 8 PARITY: N STOP BITS: 1 +``` -Notes -===== +mpc8313erdb +----------- +SPI +--- +In master mode SCS (SPI_D) cannot be used as GPIO[31]. Unfortunately this pin +is connected to the SD Card slot. See also [1] SPI 5. - \ No newline at end of file +TSEC +---- +The interrupt vector values are switched at the IPIC. See also [1] IPIC 1. + +REFERENCES: + +[1] MPC8313ECE Rev. 3, 3/2008: "MPC8313E PowerQUICC™ II Pro Integrated Host + Processor Device Errata" + +Example U-Boot Sequence +----------------------- +``` +setenv ethact TSEC1 +setenv ipaddr 192.168.96.106 +setenv serverip 192.168.96.31 +tftp 1000000 ticker.img +bootm +``` +Making a U-Boot Image +--------------------- +```shell +powerpc-rtems4.9-objcopy -O binary ticker.exe ticker.bin +gzip -9 ticker.bin +mkimage -A ppc -O rtems -T kernel -C gzip -a 100 -e 10000 -n "RTEMS +Test" -d ticker.bin.gz ticker.img +``` diff --git a/bsps/powerpc/gen83xx/README.mpc8313erdb b/bsps/powerpc/gen83xx/README.mpc8313erdb deleted file mode 100644 index 1f529ae707..0000000000 --- a/bsps/powerpc/gen83xx/README.mpc8313erdb +++ /dev/null @@ -1,28 +0,0 @@ -SPI: - -In master mode SCS (SPI_D) cannot be used as GPIO[31]. Unfortunately this pin -is connected to the SD Card slot. See also [1] SPI 5. - -TSEC: - -The interrupt vector values are switched at the IPIC. See also [1] IPIC 1. - -REFERENCES: - -[1] MPC8313ECE Rev. 3, 3/2008: "MPC8313E PowerQUICC™ II Pro Integrated Host - Processor Device Errata" - -Example U-Boot Sequence -======================= -setenv ethact TSEC1 -setenv ipaddr 192.168.96.106 -setenv serverip 192.168.96.31 -tftp 1000000 ticker.img -bootm - -Making a U-Boot Image -===================== -powerpc-rtems4.9-objcopy -O binary ticker.exe ticker.bin -gzip -9 ticker.bin -mkimage -A ppc -O rtems -T kernel -C gzip -a 100 -e 10000 -n "RTEMS -Test" -d ticker.bin.gz ticker.img diff --git a/bsps/shared/dev/nand/VERSION b/bsps/shared/dev/nand/README.md similarity index 93% rename from bsps/shared/dev/nand/VERSION rename to bsps/shared/dev/nand/README.md index 5e4eb00fe9..872d981332 100644 --- a/bsps/shared/dev/nand/VERSION +++ b/bsps/shared/dev/nand/README.md @@ -1,10 +1,13 @@ +Version +======= The information in this file describes the source of files in bsps/shared/dev/nand/ and bsps/include/dev/nand/. Import from: -https://github.com/Xilinx/embeddedsw.git + https://github.com/Xilinx/embeddedsw.git +``` commit 5330a64c8efd14f0eef09befdbb8d3d738c33ec2 Refs: Author: Nicole Baze @@ -22,3 +25,4 @@ CommitDate: Fri Oct 7 10:26:16 2022 +0530 Signed-off-by: Nicole Baze Acked-by: Jesus De Haro +``` diff --git a/bsps/shared/dev/spi/VERSION b/bsps/shared/dev/spi/README.md similarity index 91% rename from bsps/shared/dev/spi/VERSION rename to bsps/shared/dev/spi/README.md index a0acb181b6..4a06e68013 100644 --- a/bsps/shared/dev/spi/VERSION +++ b/bsps/shared/dev/spi/README.md @@ -1,3 +1,5 @@ +Version +======= The information in this file describes the source of the following files in bsps/shared/dev/spi/ and bsps/include/dev/spi/: @@ -12,8 +14,9 @@ bsps/shared/dev/spi/ and bsps/include/dev/spi/: Import from: -https://github.com/Xilinx/embeddedsw.git + https://github.com/Xilinx/embeddedsw.git +``` commit 8a89579489c88ea5acd23d7d439ac928659c26cf Author: msreeram AuthorDate: Wed Apr 6 23:24:38 2022 -0600 @@ -27,3 +30,4 @@ CommitDate: Fri Apr 8 16:47:15 2022 +0530 Signed-off-by: Manikanta Sreeram Acked-by : Meena Paleti +``` diff --git a/bsps/shared/xil/VERSION b/bsps/shared/xil/README.md similarity index 89% rename from bsps/shared/xil/VERSION rename to bsps/shared/xil/README.md index d94f574255..ff1fc736e1 100644 --- a/bsps/shared/xil/VERSION +++ b/bsps/shared/xil/README.md @@ -1,10 +1,13 @@ +Version +======= The information in this file describes the source of files in bsps/shared/xil/ and bsps/include/xil/. Import from: -https://github.com/Xilinx/embeddedsw.git + https://github.com/Xilinx/embeddedsw.git +``` commit 8a89579489c88ea5acd23d7d439ac928659c26cf Author: msreeram AuthorDate: Wed Apr 6 23:24:38 2022 -0600 @@ -18,3 +21,4 @@ CommitDate: Fri Apr 8 16:47:15 2022 +0530 Signed-off-by: Manikanta Sreeram Acked-by : Meena Paleti +``` diff --git a/cpukit/libfs/src/jffs2/VERSION b/cpukit/libfs/src/jffs2/README.md similarity index 95% rename from cpukit/libfs/src/jffs2/VERSION rename to cpukit/libfs/src/jffs2/README.md index 7302f10ef6..8bc5ca3edb 100644 --- a/cpukit/libfs/src/jffs2/VERSION +++ b/cpukit/libfs/src/jffs2/README.md @@ -1,8 +1,12 @@ +Updating +======== + This directory contains a port of the JFFS2 file system from Linux v5.9. To update to a newer Linux version use this command in a Git clone of Linux to generate the relevant patches: +```shell git format-patch v6.1..v9.99 -- \ include/uapi/linux/jffs2.h \ fs/jffs2/LICENCE \ @@ -29,8 +33,11 @@ generate the relevant patches: fs/jffs2/wbuf.c \ fs/jffs2/write.c \ fs/jffs2/xattr.h +``` The patches need a transformation of file paths from Linux to RTEMS: +```shell sed -i 's%/include/uapi%/cpukit/libfs/src/jffs2/include%g' 00* sed -i 's%/fs/jffs2%/cpukit/libfs/src/jffs2/src%g' 00* +```