Skip to content

Commit

Permalink
Merge pull request #57 from nam-ng/readme_apn_update
Browse files Browse the repository at this point in the history
Update AN and README files
  • Loading branch information
TatsuyaOgawanx authored Jan 19, 2024
2 parents 6e4afa6 + f5de445 commit fd58d8a
Show file tree
Hide file tree
Showing 20 changed files with 80 additions and 20 deletions.
6 changes: 3 additions & 3 deletions configuration/azure-rtos.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4138,7 +4138,7 @@
<path>src/smc_gen</path>
</impdir>
<impdir>
<file>configuration/samples/usbx_hmsc/README.md</file>
<file>configuration/samples/usbx_hcdc/README.md</file>
<path>.</path>
</impdir>
<!-- copy driver codes -->
Expand Down Expand Up @@ -6258,12 +6258,12 @@
<file>threadx/LICENSE.txt</file>
<file>threadx/LICENSED-HARDWARE.txt</file>
<file>threadx/SECURITY.md</file>
<file>configuration/samples/r01an6455ej0103-rx-azure-rtos.pdf</file>
<file>configuration/samples/r01an6455ej0200-rx-azure-rtos.pdf</file>
<path>.</path>
</impdir>
<openfile>
<path>README.md</path>
<path>r01an6455ej0103-rx-azure-rtos.pdf</path>
<path>r01an6455ej0200-rx-azure-rtos.pdf</path>
</openfile>
<!-- Update ewp file for IAR project setting -->
<sourceedit>
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/bare/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.1 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.1 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/boot_loader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ After device is changed, compiler setting is reset, please
Copy and replace conent of linker_script_sample.ld for current linker_script.ld under src folder of current project

1.2. For more information about how to use this sample project,
please refer to section 2.12 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.13 of r01an6455ej0200-rx-azure-rtos.pdf

1.3. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/guix_8bpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ https://docs.microsoft.com/azure/rtos/guix/about-guix


1.2. For more information about how to use this sample project,
please refer to section 2.8 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.8 of r01an6455ej0200-rx-azure-rtos.pdf

1.3. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/iot_sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.6 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.6 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/iot_sdk/rsk-rx671/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To use PMOD2, following modifications are required
- P52: J19 jumper header pin mounting (J19 Pin1-2 short), R225 removal

1.2. For more information about how to use this sample project,
please refer to section 2.6 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.6 of r01an6455ej0200-rx-azure-rtos.pdf

1.3. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/iot_sdk/rx72n-envision-kit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.6 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.6 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/iot_sdk_pnp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.7 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.7 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/iot_sdk_pnp/rsk-rx671/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To use PMOD2, following modifications are required
- P52: J19 jumper header pin mounting (J19 Pin1-2 short), R225 removal

1.2. For more information about how to use this sample project,
please refer to section 2.7 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.7 of r01an6455ej0200-rx-azure-rtos.pdf

1.3. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.7 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.7 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/iperf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.5 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.5 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/low_power/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.11 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.12 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/minimal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.2 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.2 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/ping/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.4 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.4 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/ping/rsk-rx671/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To use PMOD2, following modifications are required
- P52: J19 jumper header pin mounting (J19 Pin1-2 short), R225 removal

1.2. For more information about how to use this sample project,
please refer to section 2.4 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.4 of r01an6455ej0200-rx-azure-rtos.pdf

1.3. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
Binary file not shown.
2 changes: 1 addition & 1 deletion configuration/samples/ramdisk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.3 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.3 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
2 changes: 1 addition & 1 deletion configuration/samples/usbx_device_cdc_acm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Usage Notes
This demonstration illustrates the setup and use of USBX device CDC-ACM Class to communicate with the host as a serial device.

For more information about how to use this sample project,
please refer to section 2.9 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.9 of r01an6455ej0200-rx-azure-rtos.pdf

To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down
60 changes: 60 additions & 0 deletions configuration/samples/usbx_hcdc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---------------
1. Usage Notes
---------------
1.1. This sample project requires r_usb_basic v1.42 and r_usb_hcdc v1.42 as minimum version.
After project generation, please confirm it as following steps:
In Smart Configurator editor, go to Components tab
- If you see r_usb_basic and r_usb_hcdc configuration are blue and can see its settings,
it is okay, you don't need to do anything.
- If you see r_usb_basic and r_usb_hcdc configuration are grey off,
you can select grey component and click on the link to download missing module.
After downloading completed, click Generate Code button to generate code for it.

1.2. For more information about how to use this sample project,
please refer to section 2.11 of r01an6455ej0200-rx-azure-rtos.pdf

1.3. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Size of type 'double' is set to "64 bits" as default for IAR project
"-m64bit-doubles" build option is set as default for GCC project

1.4. Please also take note that the sample project is verified with C project.
If you create new project with C++ option, please confirm its behavior by yourself.
For example, if you create project with C++ option and CC-RX compiler, you will need to add abort() function manually.

------------------------
2. Caution / Known Issue
------------------------
2.1. When using GCC compiler, in case you set Optimization level as Optimize size(-Os), please set the linker option not to remove unused sections as following
- in Project Explorer view, right-click on the project and select Properties
- on Properties dialog select C/C++ Build -> Settings -> Tool Settings tab -> Linker -> Other
- add "-Wl,--no-gc-sections" on User defined options
- click Apply and Close" button

2.2. When using GCC compiler, the "_end" section in src/linker_script.ld should be at the end. However, the default linker script may not meet this order, so please check linker_script.ld and move the section below to the end if needed, and build project again
.bss :
{
_bss = .;
*(.bss)
*(.bss.**)
*(COMMON)
*(B)
*(B_1)
*(B_2)
_ebss = .;
_end = .;
} > RAM

2.3. If you are using RSK board (RSK RX65N, RSK RX671), please do the pin assignment check for USB0_VBUSEN.
In Smart Configurator editor (<projectname>.scfg)
- go to Pins tab
- at Pin Function, select USB0 on the left panel
- on the right panel, check and change USB0_VBUSEN pin number if it is incorrect (there is a warning icon)

This issue will be fixed at that next update of RSK board description file.

2.4 When using RX microcontrollers with DPFPU
Target projects (RX72N, RX671):
- Projects with the double precision floating point instruction generation option (CC-RX: -dpfpu, GCC: --mdfpu=64, IAR: --fpu=64) enabled on RXv3 core devices
Workaround:
- Call tx_thread_fpu_enable() at the beginning of every task.
2 changes: 1 addition & 1 deletion configuration/samples/usbx_hmsc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Usage Notes
---------------
1.1. For more information about how to use this sample project,
please refer to section 2.10 of r01an6455ej0103-rx-azure-rtos.pdf
please refer to section 2.10 of r01an6455ej0200-rx-azure-rtos.pdf

1.2. To keep 8 bytes size for double type
"-dbl_size=8" compiler build option is set as default for CC-RX project
Expand Down

0 comments on commit fd58d8a

Please sign in to comment.