Skip to content

Commit ea2e282

Browse files
ajaybhargavajaybhargav
committed
docs: update documentation and add rda8955 details
Signed-off-by: Ajay Bhargav <[email protected]>
1 parent c56e3d6 commit ea2e282

File tree

12 files changed

+215
-26
lines changed

12 files changed

+215
-26
lines changed

‎docs/book/api/peri/adc.rst‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ Analog to Digital Converter
55

66
<br>
77

8-
There are 10-bit analog ports available on GSM modules. Input voltage
9-
range from 0-2.8v gives digital output of 0-1023.
8+
There are 10-bit analog ports available on GSM modules based on MT6261 or
9+
MT2503. Input voltage range from 0-2.8v gives digital output of 0-1023. On
10+
RDA8955 based modules, Input voltage range is from 0-1.8v gives digital
11+
output of 0 - 1023.
1012

1113
However analog ports on NBIoT module are 12-but and input voltage range
1214
from 0-1.4v with digital output of 0-4095.
@@ -54,6 +56,21 @@ Application Example
5456
GSM/NB-IoT Module ADC Channel Mapping
5557
-------------------------------------
5658

59+
RDA8955 based modules
60+
^^^^^^^^^^^^^^^^^^^^^
61+
62+
+--------------+------------+------------+----------+
63+
| ADC Channel | M590 Pin | MC65 Pin | A9 Pin |
64+
+==============+============+============+==========+
65+
| ADC CH 0 | Pin 16 | Pin 6 | Pin 15 |
66+
+--------------+------------+------------+----------+
67+
| ADC CH 1 | Pin 17 | Pin 47 | Pin 16 |
68+
+--------------+------------+------------+----------+
69+
70+
71+
MT2503/MT6261/MT2625 based modules
72+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
73+
5774
+--------------+------------------+-----------+-----------------+-----------+------------+------------+
5875
| ADC Channel | MC20U Pin | M56 Pin | MC60 Pin | M66 Pin | BC20 Pin | SIM868 |
5976
| | | | |br| MC20 Pin | | | Pin |

‎docs/book/api/peri/bluetooth.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ is available.
1010

1111
Currently only SPP profile is supported by SDK.
1212

13-
System create device file /dev/bthost0 for host mode of operation. This file
13+
System create device file ``/dev/bthost0`` for host mode of operation. This file
1414
can be used to perform standard IO operations (open, close, read, write etc.).
1515
SDK also provide api to enable console over bluetooth, If console is enabled
1616
then host operation file will not be available for application.
1717

18-
For client mode of operation device files are created under /dev/btclient/
18+
For client mode of operation device files are created under ``/dev/btclient/``
1919
after Bluetooth device search is performed. Application can initiate pairing
2020
and standard io operation can then be performed via system calls.
2121

‎docs/book/api/peri/display.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Display Driver API
55

66
<br>
77

8-
.. note:: Display driver is currently only available on 4G platforms
8+
.. note:: Display driver is currently only available on modules based on RDA8910 and RDA8955.
99

1010
Application Example
1111
-------------------

‎docs/book/api/peri/gpio.rst‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,90 @@ Application Example
155155
GSM/NB-IoT Module GPIO Mapping
156156
------------------------------
157157

158+
RDA8955 based modules
159+
^^^^^^^^^^^^^^^^^^^^^
160+
161+
+------------+------------+------------+----------+
162+
| GPIO Name | M590 Pin | MC65 Pin | A9 Pin |
163+
+============+============+============+==========+
164+
| GPIO_0 | Pin 7 | Pin 33 | Pin 53 |
165+
+------------+------------+------------+----------+
166+
| GPIO_1 | Pin 8 | Pin 34 | Pin 54 |
167+
+------------+------------+------------+----------+
168+
| GPIO_2 | Pin 41 | Pin 38 | Pin 52 |
169+
+------------+------------+------------+----------+
170+
| GPIO_3 | Pin 42 | Pin 39 | Pin 51 |
171+
+------------+------------+------------+----------+
172+
| GPIO_4 | Pin 59 | Pin 24 | Pin 49 |
173+
+------------+------------+------------+----------+
174+
| GPIO_5 | Pin 58 | Pin 25 | Pin 50 |
175+
+------------+------------+------------+----------+
176+
| GPIO_6 | Pin 60 | Pin 35 | Pin 48 |
177+
+------------+------------+------------+----------+
178+
| GPIO_7 | Pin 61 | Pin 36 | Pin 47 |
179+
+------------+------------+------------+----------+
180+
| GPIO_8 | Pin 35 | Pin 8 | Pin 8 |
181+
+------------+------------+------------+----------+
182+
| GPIO_9 | Pin 34 | Pin 7 | Pin 7 |
183+
+------------+------------+------------+----------+
184+
| GPIO_10 | Pin 33 | Pin 9 | Pin 6 |
185+
+------------+------------+------------+----------+
186+
| GPIO_11 | Pin 32 | Pin 10 | Pin 5 |
187+
+------------+------------+------------+----------+
188+
| GPIO_12 | Pin 31 | Pin 11 | Pin 4 |
189+
+------------+------------+------------+----------+
190+
| GPIO_13 | Pin 30 | Pin 12 | Pin 3 |
191+
+------------+------------+------------+----------+
192+
| GPIO_14 | Pin 56 | Pin 59 | Pin 20 |
193+
+------------+------------+------------+----------+
194+
| GPIO_15 | Pin 55 | Pin 61 | Pin 19 |
195+
+------------+------------+------------+----------+
196+
| GPIO_16 | Pin 53 | Pin 62 | Pin 23 |
197+
+------------+------------+------------+----------+
198+
| GPIO_17 | Pin 54 | Pin 60 | Pin 21 |
199+
+------------+------------+------------+----------+
200+
| GPIO_18 | Pin 57 | -- | Pin 22 |
201+
+------------+------------+------------+----------+
202+
| GPIO_19 | Pin 23 | Pin 56 | Pin 1 |
203+
+------------+------------+------------+----------+
204+
| GPIO_20 | Pin 24 | Pin 65 | Pin 2 |
205+
+------------+------------+------------+----------+
206+
| GPIO_21 | Pin 25 | Pin 64 | -- |
207+
+------------+------------+------------+----------+
208+
| GPIO_22 | Pin 26 | Pin 57 | -- |
209+
+------------+------------+------------+----------+
210+
| GPIO_23 | Pin 27 | Pin 58 | -- |
211+
+------------+------------+------------+----------+
212+
| GPIO_24 | Pin 28 | Pin 63 | -- |
213+
+------------+------------+------------+----------+
214+
| GPIO_25 | Pin 10 | -- | Pin 32 |
215+
+------------+------------+------------+----------+
216+
| GPIO_26 | -- | -- | Pin 25 |
217+
+------------+------------+------------+----------+
218+
| GPIO_27 | -- | -- | Pin 26 |
219+
+------------+------------+------------+----------+
220+
| GPIO_28 | -- | -- | Pin 30 |
221+
+------------+------------+------------+----------+
222+
| GPIO_29 | Pin 9 | -- | Pin 24 |
223+
+------------+------------+------------+----------+
224+
| GPIO_30 | Pin 5 | Pin 28 | Pin 31 |
225+
+------------+------------+------------+----------+
226+
| GPIO_31 | Pin 17 | Pin 47 | Pin 16 |
227+
+------------+------------+------------+----------+
228+
| GPIO_32 | Pin 50 | Pin 37 | -- |
229+
+------------+------------+------------+----------+
230+
| GPIO_33 | Pin 66 | -- | -- |
231+
+------------+------------+------------+----------+
232+
| GPIO_34 | Pin 64 | Pin 46 | -- |
233+
+------------+------------+------------+----------+
234+
| GPIO_35 | Pin 63 | Pin 30 | Pin 38 |
235+
+------------+------------+------------+----------+
236+
| GPIO_36 | Pin 62 | Pin 29 | Pin 37 |
237+
+------------+------------+------------+----------+
238+
239+
MT2503/MT6261/MT2625 based modules
240+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
241+
158242
+------------+------------------+-----------+-----------------+-----------+------------+------------+
159243
| GPIO Name | MC20U Pin | M56 Pin | MC60 Pin | M66 Pin | BC20 Pin | SIM868 |
160244
| | | | |br| MC20 Pin | | | Pin |

‎docs/book/api/peri/i2c.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,31 @@ I2C Port 1
7171
GSM/NB-IoT Module I2C Port Mapping
7272
----------------------------------
7373

74+
RDA8955 based modules provide two I2C ports. Following is the pin mapping:
75+
76+
I2C Port 0
77+
^^^^^^^^^^
78+
79+
+---------+------------+------------+----------+
80+
| I2C Pin | M590 Pin | MC65 Pin | A9 Pin |
81+
+=========+============+============+==========+
82+
| SCL | Pin 23 | Pin 56 | Pin 1 |
83+
+---------+------------+------------+----------+
84+
| SDA | Pin 24 | Pin 65 | Pin 2 |
85+
+---------+------------+------------+----------+
86+
87+
I2C Port 1
88+
^^^^^^^^^^
89+
90+
+---------+----------+----------+--------+
91+
| I2C Pin | M590 Pin | MC65 Pin | A9 Pin |
92+
+=========+==========+==========+========+
93+
| SCL | Pin 60 | Pin 35 | Pin 48 |
94+
+---------+----------+----------+--------+
95+
| SDA | Pin 61 | Pin 36 | Pin 47 |
96+
+---------+----------+----------+--------+
97+
98+
7499
GSM (MT2503, MT6261) and NB-IoT (MT2625) chipset supported modules expose only one
75100
I2C port. Following is the pin mapping for SCL and SDA:
76101

‎docs/book/api/peri/pwm.rst‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ PWM
99
4G LTE Module PWM Channel Mapping
1010
---------------------------------
1111

12-
.. note:: PWM Channel 1 on RD8910 based modules has limited configurable period and duty cycle.
12+
.. note:: PWM Channel 1 on RDA8910 and RDA8955 based modules has limited configurable period and duty cycle.
1313

1414
+--------------+-----------+-----------+----------+----------+----------+----------+
1515
| PWM Channel | EC600U | EC200U | N58 | N716 | L610 | EG915U |
@@ -23,6 +23,21 @@ PWM
2323
GSM/NB-IoT Module PWM Channel Mapping
2424
-------------------------------------
2525

26+
RDA8955 based modules
27+
^^^^^^^^^^^^^^^^^^^^^
28+
29+
+--------------+------------+------------+----------+
30+
| PWM Channel | M590 Pin | MC65 Pin | A9 Pin |
31+
+==============+============+============+==========+
32+
| PWM CH 0 | Pin 58 | Pin 25 | Pin 50 |
33+
+--------------+------------+------------+----------+
34+
| PWM CH 1 | Pin 59 | Pin 24 | Pin 49 |
35+
+--------------+------------+------------+----------+
36+
37+
38+
MT2503/MT6261/MT2625 based modules
39+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40+
2641
+--------------+-----------+-------------------+-----------+------------+------------+
2742
| PWM Channel | M56 Pin | MC60 Pin | M66 Pin | BC20 Pin | SIM868 |
2843
| | | |br| MC20(U) Pin | | | Pin |

‎docs/book/api/peri/sdmmc.rst‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
SD/MMC Driver
22
=============
33

4-
Following API only apply to 4G modems, On 2G modems SD card is mounted
5-
automatically if detected on power-up.
4+
Following API only apply to RDA8910 and RDA8955 based modems, On 2G modems
5+
based on MT2503/MT6261 SD card is mounted automatically if detected during
6+
power-up.
67

7-
Once card is mounted, it is available on VFS path "/sd". All standard file
8+
Once card is mounted, it is available on VFS path ``/sd``. All standard file
89
IO operations (open, close, read, write etc.) can be performed.
910

1011
Example use
@@ -23,12 +24,13 @@ Example use
2324
/* To Unmount card */
2425
sdmmc_unmount();
2526
27+
2628
Read More
2729
---------
2830

29-
Standard IO <syscall/stdio>
30-
Directory <syscall/dirent>
31-
Fileystem <syscall/statvfs>
31+
Standard IO <../system/syscall/stdio>
32+
Directory <../system/syscall/dirent>
33+
Fileystem <../system/syscall/statvfs>
3234

3335

3436
API Reference

‎docs/book/api/peri/spi.rst‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ RDA8910 provide 2 ports.
1212
Chip Select Control
1313
-------------------
1414

15-
MT2503/MT6261
16-
^^^^^^^^^^^^^
15+
MT2503/MT6261/RDA8955
16+
^^^^^^^^^^^^^^^^^^^^^
1717

1818
Chip select (CS) line on GSM module doubles as GPIO. SPI driver provide option to
1919
let SPI controller Control CS line per transaction basis or CS line can be controlled
@@ -104,8 +104,27 @@ SPI Port 1
104104
GSM/NB-IoT Module SPI Port Mapping
105105
----------------------------------
106106

107-
GSM (MT2503, MT6261) and NB-IoT (MT2625) chipset supported modules expose only one
108-
I2C port. Following is the pin mapping for SPI Port 0.
107+
GSM (MT2503, MT6261, RDA8955) and NB-IoT (MT2625) chipset supported modules expose only one
108+
SPI port. Following is the pin mapping for SPI Port 0.
109+
110+
RDA8955 based modules
111+
^^^^^^^^^^^^^^^^^^^^^
112+
113+
+---------+------------+------------+----------+
114+
| I2C Pin | M590 Pin | MC65 Pin | A9 Pin |
115+
+=========+============+============+==========+
116+
| MISO | Pin 31 | Pin 11 | Pin 4 |
117+
+---------+------------+------------+----------+
118+
| MOSI | Pin 32 | Pin 10 | Pin 5 |
119+
+---------+------------+------------+----------+
120+
| CLK | Pin 35 | Pin 8 | Pin 8 |
121+
+---------+------------+------------+----------+
122+
| CS | Pin 34 | Pin 7 | Pin 7 |
123+
+---------+------------+------------+----------+
124+
125+
126+
MT2503/MT6261/MT2625 based modules
127+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
109128

110129
+---------+-----------+-------------------+-----------+------------+------------+
111130
| SPI Pin | M56 Pin | MC60 Pin | M66 Pin | BC20 Pin | SIM868 |

‎docs/book/api/peri/spifs.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
SPI Flash Fileystem API
22
=======================
33

4-
SPI Flash when enabled is mounted on VFS path "/sf" with LittleFS filesystem.
4+
SPI Flash when enabled is mounted on VFS path ``/sf`` with LittleFS filesystem.
55

66
Chip Select Selection
77
^^^^^^^^^^^^^^^^^^^^^

‎docs/book/api/peri/uart.rst‎

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,22 @@ UART
88
The UART devices are registered on VFS as device files accessible via startard IO system calls
99
and termios API.
1010

11-
UART devices are registed under /dev/ttySx, where x is uart number starting from 0.
11+
UART devices are registed under ``/dev/ttySx``, where x is uart number starting from 0.
1212

1313
On both MT6261/MT2503 based GSM modules and RDA8910 based 4G LTE modules, three hardware uart
14-
interfaces are available. On devices with on-board GNSS, 2 UARTs are exposed on external pins
14+
interfaces are available. On RDA8955 based modules two hardware UARTs are available.
15+
16+
On devices with on-board GNSS (SIM868/N58-CA/EC200U), 2 UARTs are exposed on external pins
1517
whereas 1 UART is connected to GNSS as a dedicated interface.
1618

1719
On modules like MC60/MC20, GNSS port is also exposed on outside pins which provides freedom to
1820
select any UART port to be connected to GNSS module.
1921

20-
The three UART device files are:
22+
So if module has three physical UART interface, the three UART device files will be:
2123

22-
* /dev/ttyS0
23-
* /dev/ttyS1
24-
* /dev/ttyS2
24+
* ``/dev/ttyS0``
25+
* ``/dev/ttyS1``
26+
* ``/dev/ttyS2``
2527

2628
Each device file supports standard system calls for IO operations (open, read, write, close etc.)
2729

@@ -85,6 +87,25 @@ Application Example
8587
GSM Module Pin Mapping
8688
----------------------
8789

90+
RDA8955 based modules
91+
^^^^^^^^^^^^^^^^^^^^^
92+
93+
+---------------+-----------+-----------+----------+
94+
| UART Function | M590 | MC65 | A9 |
95+
+===============+===========+===========+==========+
96+
| UART0 TXD | Pin 8 | Pin 34 | Pin 54 |
97+
+---------------+-----------+-----------+----------+
98+
| UART0 RXD | Pin 7 | Pin 33 | Pin 53 |
99+
+---------------+-----------+-----------+----------+
100+
| UART1 TXD | Pin 58 | Pin 25 | Pin 50 |
101+
+---------------+-----------+-----------+----------+
102+
| UART1 RXD | Pin 59 | Pin 24 | Pin 49 |
103+
+---------------+-----------+-----------+----------+
104+
105+
106+
MT2503/MT6261/MT2625 based modules
107+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
108+
88109
+---------------+------------------+-----------+-----------------+-----------+------------+
89110
| UART Function | MC20 Pin | M56 Pin | MC60 Pin | M66 Pin | SIM868 |
90111
| | |br| MC20U Pin | | | | Pin |

0 commit comments

Comments
 (0)