Skip to content

Commit 2fe4a37

Browse files
mcatee-infineonmmahadevan108
mcatee-infineon
authored and
mmahadevan108
committed
Documentation: Update documenation for Infineon boards
 -Update formatting and contents of index.rst for cy8ckit_062s4 -Update formatting and contents of index.rst for cy8ckit_064s0s2_4343w -Update formatting and contents of index.rst for cy8cproto_062_4343w -Update formatting and contents of index.rst for cy8cproto_063_ble -Update formatting and contents of index.rst for xmc45_relax_kit -Update formatting and contents of index.rst for xmc47_relax_kit -Change all instances of "PSoC" to "PSOC" for infineon platforms Signed-off-by: McAtee Maxwell <[email protected]>
1 parent 422a41d commit 2fe4a37

File tree

62 files changed

+407
-277
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+407
-277
lines changed

‎boards/cypress/cy8ckit_062_ble/Kconfig.cy8ckit_062_ble

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PSoC6 BLE Pioneer Kit configuration
1+
# PSOC 6 BLE Pioneer Kit configuration
22

33
# Copyright (c) 2018 Cypress
44
# Copyright (c) 2020 ATL Electronics

‎boards/cypress/cy8ckit_062_ble/board.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
board:
22
name: cy8ckit_062_ble
3-
full_name: PSoC63 BLE Pioneer Kit
3+
full_name: PSOC 63 BLE Pioneer Kit
44
vendor: cypress
55
revision:
66
format: "major.minor.patch"

‎boards/cypress/cy8ckit_062_ble/cy8ckit_062_ble_cy8c6347_m0.dts

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
#include "cy8ckit_062_ble_common.dtsi"
1212

1313
/ {
14-
model = "Cypress PSoC6 BLE Pioneer Kit";
14+
model = "Cypress PSOC 6 BLE Pioneer Kit";
1515
compatible = "cypress,cy8c6xx7_cm0p", "cypress,psoc6";
1616

1717
chosen {

‎boards/cypress/cy8ckit_062_ble/cy8ckit_062_ble_cy8c6347_m0_0_0_0.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#
77

88
identifier: [email protected]/cy8c6347/m0
9-
name: Cypress PSoC6 BLE Pioneer Kit (M0, rev. 0.0.0)
9+
name: Cypress PSOC 6 BLE Pioneer Kit (M0, rev. 0.0.0)
1010
type: mcu
1111
arch: arm
1212
ram: 288

‎boards/cypress/cy8ckit_062_ble/cy8ckit_062_ble_cy8c6347_m0_1_0_0.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#
77

88
identifier: [email protected]/cy8c6347/m0
9-
name: Cypress PSoC6 BLE Pioneer Kit (M0, rev. 1.0.0)
9+
name: Cypress PSOC 6 BLE Pioneer Kit (M0, rev. 1.0.0)
1010
type: mcu
1111
arch: arm
1212
ram: 288

‎boards/cypress/cy8ckit_062_ble/cy8ckit_062_ble_cy8c6347_m4.dts

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#include "cy8ckit_062_ble_cy8c6347-pinctrl.dtsi"
1313

1414
/ {
15-
model = "Cypress PSoC6 BLE Pioneer Kit";
15+
model = "Cypress PSOC 6 BLE Pioneer Kit";
1616
compatible = "cypress,cy8c6xx7_cm4", "cypress,psoc6";
1717

1818
aliases {

‎boards/cypress/cy8ckit_062_ble/cy8ckit_062_ble_cy8c6347_m4_0_0_0.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#
77

88
identifier: [email protected]/cy8c6347/m4
9-
name: Cypress PSoC6 BLE Pioneer Kit (M4, rev. 0.0.0)
9+
name: Cypress PSOC 6 BLE Pioneer Kit (M4, rev. 0.0.0)
1010
type: mcu
1111
arch: arm
1212
ram: 288

‎boards/cypress/cy8ckit_062_ble/cy8ckit_062_ble_cy8c6347_m4_1_0_0.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#
77

88
identifier: [email protected]/cy8c6347/m4
9-
name: Cypress PSoC6 BLE Pioneer Kit (M4, rev. 1.0.0)
9+
name: Cypress PSOC 6 BLE Pioneer Kit (M4, rev. 1.0.0)
1010
type: mcu
1111
arch: arm
1212
ram: 288

‎boards/cypress/cy8ckit_062_ble/doc/index.rst

+30-30
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
.. _cy8ckit_062_ble:
22

3-
INFINEON PSoC63 BLE Pioneer Kit
4-
###############################
3+
INFINEON PSOC 63 BLE Pioneer Kit
4+
################################
55

66
Overview
77
********
88

9-
The PSoC 6 BLE Pioneer Kit (CY8CKIT-062-BLE) is a hardware platform that
10-
enables design and debug of the Cypress PSoC 63 BLE MCU.
9+
The PSOC 6 BLE Pioneer Kit (CY8CKIT-062-BLE) is a hardware platform that
10+
enables design and debug of the Cypress PSOC 63 BLE MCU.
1111

12-
The PSoC 6 BLE Pioneer Kit features the PSoC 63 MCU: a dual-core MCU, with a
12+
The PSOC 6 BLE Pioneer Kit features the PSOC 63 MCU: a dual-core MCU, with a
1313
150-MHz Arm Cortex-M4 as the primary application processor and a 100-MHz Arm
1414
Cortex-M0+ that supports low-power operations, 1MB of Flash, 288KB of SRAM,
1515
an integrated BLE 4.2 radio, 78 GPIO, 7 programmable analog blocks, 12
1616
programmable digital blocks, and capacitive-sensing with CapSense.
1717

18-
The PSoC 6 BLE Pioneer board offers compatibility with Arduino shields, a
18+
The PSOC 6 BLE Pioneer board offers compatibility with Arduino shields, a
1919
512-Mb NOR flash, onboard programmer/debugger (KitProg2), USB Type-C power
2020
delivery system (EZ-PD™ CCG3), 5-segment CapSense slider, two CapSense
2121
buttons, one CapSense proximity sensing header, an RGB LED, two user LEDs,
@@ -42,45 +42,45 @@ enables the CM4 core.
4242
6. KitProg2 I/O header (J6)1
4343
7. KitProg2 programming/custom application header (J7)1
4444
8. External power supply connector (J9)
45-
9. PSoC 6 BLE user button (SW2)
45+
9. PSOC 6 BLE user button (SW2)
4646
10. KitProg2 application selection button (SW4)
4747
11. Digilent® Pmod™ compatible I/O header (J14)1
4848
12. Power LED (LED4)
4949
13. KitProg2 status LEDs (LED1, LED2, and LED3)
50-
14. PSoC 6 reset button (SW1)
51-
15. PSoC 6 I/O header (J18, J19 and J20)
50+
14. PSOC 6 reset button (SW1)
51+
15. PSOC 6 I/O header (J18, J19 and J20)
5252
16. Arduino™ Uno R3 compatible power header (J1)
53-
17. PSoC 6 debug and trace header (J12)
54-
18. Arduino Uno R3 compatible PSoC 6 I/O header (J2, J3 and J4)
55-
19. PSoC 6 program and debug header (J11)
53+
17. PSOC 6 debug and trace header (J12)
54+
18. Arduino Uno R3 compatible PSOC 6 I/O header (J2, J3 and J4)
55+
19. PSOC 6 program and debug header (J11)
5656
20. KitProg2 programming target selection switch (SW6)
5757
21. CapSense slider and buttons
5858
22. CapSense proximity header (J13)
59-
23. PSoC 6 BLE VDD selection switch (SW5)
60-
24. PSoC 6 BLE power monitoring jumper (J8)2
59+
23. PSOC 6 BLE VDD selection switch (SW5)
60+
24. PSOC 6 BLE power monitoring jumper (J8)2
6161
25. Arduino Uno R3 compatible ICSP header (J5)1
62-
26. PSoC 6 user LEDs (LED8 and LED9)
62+
26. PSOC 6 user LEDs (LED8 and LED9)
6363
27. RGB LED (LED5)
6464
28. Cypress 512-Mbit serial NOR Flash memory (S25FL512S, U4)
6565
29. Cypress serial Ferroelectric RAM (U5)1
6666
30. VBACKUP and PMIC control selection switch (SW7)2
67-
31. Cypress PSoC 6 BLE (CY8C6347BZI-BLD53, U1)
67+
31. Cypress PSOC 6 BLE (CY8C6347BZI-BLD53, U1)
6868
32. BLE Antenna
6969
33. U.FL connector for external antenna (J17)1
7070
34. Cypress main voltage regulator (MB39C022G, U6)
71-
35. KitProg2 (PSoC 5LP) programmer and debugger(CY8C5868LTI-LP039, U2)
71+
35. KitProg2 (PSOC 5LP) programmer and debugger(CY8C5868LTI-LP039, U2)
7272
36. Battery connector (J15)1,2
7373
37. USB PD output voltage (9V/12V) connector (J16)
7474

7575
Hardware
7676
********
7777

78-
For more information about the PSoC 63 BLE MCU SoC and CY8CKIT-062-BLE board:
78+
For more information about the PSOC 63 BLE MCU SoC and CY8CKIT-062-BLE board:
7979

80-
- `PSoC 63 BLE MCU SoC Website`_
81-
- `PSoC 63 BLE MCU Datasheet`_
82-
- `PSoC 63 BLE MCU Architecture Reference Manual`_
83-
- `PSoC 63 BLE MCU Register Reference Manual`_
80+
- `PSOC 63 BLE MCU SoC Website`_
81+
- `PSOC 63 BLE MCU Datasheet`_
82+
- `PSOC 63 BLE MCU Architecture Reference Manual`_
83+
- `PSOC 63 BLE MCU Register Reference Manual`_
8484
- `CY8CKIT-062-BLE Website`_
8585
- `CY8CKIT-062-BLE User Guide`_
8686
- `CY8CKIT-062-BLE Schematics`_
@@ -118,18 +118,18 @@ Cortex-M4
118118
System Clock
119119
============
120120

121-
The PSoC 63 BLE MCU SoC is configured to use the internal IMO+FLL as a source for
121+
The PSOC 63 BLE MCU SoC is configured to use the internal IMO+FLL as a source for
122122
the system clock. CM0+ works at 50MHz, CM4 - at 100MHz. Other sources for the
123123
system clock are provided in the SOC, depending on your system requirements.
124124

125125
Serial Port
126126
===========
127127

128-
The PSoC 63 BLE MCU SoC has 8 SCB blocks and each one can be configured as
128+
The PSOC 63 BLE MCU SoC has 8 SCB blocks and each one can be configured as
129129
UART/SPI/I2C interfaces for serial communication. At the moment UART5 on SCB5
130130
and UART6 on SCB6 are configured. SCB5 is connected to the onboard KitProg2's
131131
USB-UART Bridge working as a serial console interface. SCB6 to P13_0, P13_1
132-
pins on the J3 of the Arduino Uno R3 compatible PSoC6 I/O header for general
132+
pins on the J3 of the Arduino Uno R3 compatible PSOC 6 I/O header for general
133133
purposes.
134134

135135
OpenOCD Installation
@@ -149,7 +149,7 @@ Programming and Debugging
149149

150150
The CY8CKIT-062-BLE includes an onboard programmer/debugger (KitProg2) with
151151
mass storage programming to provide debugging, flash programming, and serial
152-
communication over USB. There are also PSoC 6 program and debug headers J11
152+
communication over USB. There are also PSOC 6 program and debug headers J11
153153
and J12 that can be used with Segger J-Link [default].
154154
A watchdog timer is enabled by default. To disable it call Cy_WDT_Unlock() and
155155
Cy_WDT_Disable().
@@ -285,16 +285,16 @@ References
285285

286286
.. target-notes::
287287

288-
.. _PSoC 63 BLE MCU SoC Website:
288+
.. _PSOC 63 BLE MCU SoC Website:
289289
https://www.cypress.com/products/32-bit-arm-cortex-m4-cortex-m0-psoc-63-connectivity-line
290290

291-
.. _PSoC 63 BLE MCU Datasheet:
291+
.. _PSOC 63 BLE MCU Datasheet:
292292
https://www.cypress.com/documentation/datasheets/psoc-6-mcu-psoc-63-ble-datasheet-programmable-system-chip-psoc
293293

294-
.. _PSoC 63 BLE MCU Architecture Reference Manual:
294+
.. _PSOC 63 BLE MCU Architecture Reference Manual:
295295
https://www.cypress.com/documentation/technical-reference-manuals/psoc-6-mcu-psoc-63-ble-architecture-technical-reference
296296

297-
.. _PSoC 63 BLE MCU Register Reference Manual:
297+
.. _PSOC 63 BLE MCU Register Reference Manual:
298298
https://www.cypress.com/documentation/technical-reference-manuals/psoc-6-mcu-cy8c63x6-cy8c63x7-cy8c63x6-cy8c63x7-registers
299299

300300
.. _CY8CKIT-062-BLE Website:

‎boards/cypress/cy8ckit_062_wifi_bt/Kconfig.cy8ckit_062_wifi_bt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PSoC6 WiFi-BT Pioneer Kit configuration
1+
# PSOC 6 WiFi-BT Pioneer Kit configuration
22

33
# Copyright (c) 2018 Cypress
44
# Copyright (c) 2020 ATL Electronics

‎boards/cypress/cy8ckit_062_wifi_bt/board.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
board:
22
name: cy8ckit_062_wifi_bt
3-
full_name: PSoC6 WiFi-BT Pioneer Kit
3+
full_name: PSOC 6 WiFi-BT Pioneer Kit
44
vendor: cypress
55
socs:
66
- name: cy8c6247

‎boards/cypress/cy8ckit_062_wifi_bt/cy8ckit_062_wifi_bt_cy8c6247_m0.dts

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
#include "cy8ckit_062_wifi_bt_cy8c6247-pinctrl.dtsi"
1313

1414
/ {
15-
model = "cy8ckit_062_wifi_bt_m0 with a Cypress PSoC6 SoC";
16-
compatible = "cypress,cy8ckit_062_wifi_bt_m0", "cypress,PSoC6";
15+
model = "cy8ckit_062_wifi_bt_m0 with a Cypress PSOC 6 SoC";
16+
compatible = "cypress,cy8ckit_062_wifi_bt_m0", "cypress,PSOC6";
1717

1818
aliases {
1919
sw0 = &user_bt;

‎boards/cypress/cy8ckit_062_wifi_bt/cy8ckit_062_wifi_bt_cy8c6247_m0.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66

77
identifier: cy8ckit_062_wifi_bt/cy8c6247/m0
8-
name: Cypress PSoC6 WiFi-BT Pioneer Kit (M0)
8+
name: Cypress PSOC 6 WiFi-BT Pioneer Kit (M0)
99
type: mcu
1010
arch: arm
1111
ram: 288

‎boards/cypress/cy8ckit_062_wifi_bt/cy8ckit_062_wifi_bt_cy8c6247_m4.dts

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
#include "cy8ckit_062_wifi_bt_cy8c6247-pinctrl.dtsi"
1111

1212
/ {
13-
model = "cy8ckit_062_wifi_bt_m4 with a Cypress PSoC6 SoC";
14-
compatible = "cypress,cy8ckit_062_wifi_bt_m4", "cypress,PSoC6";
13+
model = "cy8ckit_062_wifi_bt_m4 with a Cypress PSOC 6 SoC";
14+
compatible = "cypress,cy8ckit_062_wifi_bt_m4", "cypress,PSOC6";
1515

1616
aliases {
1717
uart-5 = &uart5;

‎boards/cypress/cy8ckit_062_wifi_bt/cy8ckit_062_wifi_bt_cy8c6247_m4.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66

77
identifier: cy8ckit_062_wifi_bt/cy8c6247/m4
8-
name: Cypress PSoC6 WiFi-BT Pioneer Kit (M4)
8+
name: Cypress PSOC 6 WiFi-BT Pioneer Kit (M4)
99
type: mcu
1010
arch: arm
1111
ram: 288

0 commit comments

Comments
 (0)