Initializing a modem vendor library means to implement **const HRilOps \*RilInitOps\(const struct HRilReport \*reportOps\)** function in the vendor library. This function is mainly used to:
Initializing a modem vendor library means to implement **const HRilOps \*RilInitOps\(const struct HRilReport \*reportOps\)** function in the vendor library. This function is mainly used to:
- Receive function pointers to event callbacks of RIL Adapter. When a service event needs to be reported, the target pointer will be called to report the event to RIL Adapter.
- Receive function pointers to event callbacks of RIL Adapter. When a service event needs to be reported, the target pointer will be called to report the event to RIL Adapter.
- Create a thread for reading modem nodes. In this thread, the data reported by the modem is read cyclically and parsed as a specific service event for reporting.
- Create a thread for reading modem nodes. In this thread, the data reported by the modem is read cyclically and parsed as a specific service event for reporting.
...
@@ -14,29 +14,15 @@ Initializing a modem vendor library means to implement **const HRilOps \*RilIni
...
@@ -14,29 +14,15 @@ Initializing a modem vendor library means to implement **const HRilOps \*RilIni
The following table describes the API for initializing a modem vendor library.
The following table describes the API for initializing a modem vendor library.
**Table 1** API for initializing a modem vendor library
**Table 1** API for initializing a modem vendor library
| const HRilOps \*RilInitOps(const struct HRilReport \* reportOps) | Provides an entry for running a modem vendor library.<br>Input parameter:<br>**reportOps**: Specifies the pointer to the event callback function, which is passed by RIL Adapter.<br/>Return result: function pointer of the service request API. |
<tdclass="cellrowborder"valign="top"width="50%"headers="mcps1.2.3.1.2 "><pid="p239mcpsimp"><aname="p239mcpsimp"></a><aname="p239mcpsimp"></a>Function: Provides an entry for running a modem vendor library.</p>
<pid="p240mcpsimp"><aname="p240mcpsimp"></a><aname="p240mcpsimp"></a><strongid="b164737479278"><aname="b164737479278"></a><aname="b164737479278"></a>reportOps</strong>: Specifies the pointer to the event callback function, which is passed by RIL Adapter.</p>
<pid="p241mcpsimp"><aname="p241mcpsimp"></a><aname="p241mcpsimp"></a>Return result: function pointer of the service request API.</p>
</td>
</tr>
</tbody>
</table>
### How to Develop<a name="section51031144122"></a>
### How to Develop<a name="section51031144122"></a>
1. Set the event callback function pointers passed by RIL Adapter through **RilInitOps**.
1. Set the event callback function pointers passed by RIL Adapter through **RilInitOps**.
```
```
// Define the callback function pointers of the modem vendor library.
// Define the callback function pointers of the modem vendor library.
...
@@ -51,7 +37,7 @@ The following table describes the API for initializing a modem vendor library.
...
@@ -51,7 +37,7 @@ The following table describes the API for initializing a modem vendor library.
```
```
1. Create the **g\_reader** main thread to enable message looping.
1. Create the **g\_reader** main thread to enable message looping.
```
```
pthread_attr_t t;
pthread_attr_t t;
...
@@ -61,7 +47,7 @@ The following table describes the API for initializing a modem vendor library.
...
@@ -61,7 +47,7 @@ The following table describes the API for initializing a modem vendor library.
```
```
1. In the **g\_eventListeners** thread, use **open\(\)** to open a modem node and then create the **g\_reader** thread to read and process messages reported by the modem.
1. In the **g\_eventListeners** thread, use **open\(\)** to open a modem node and then create the **g\_reader** thread to read and process messages reported by the modem.
```
```
g_fd = open(g_devicePath, O_RDWR); // Open the device node specified by g_devicePath.
g_fd = open(g_devicePath, O_RDWR); // Open the device node specified by g_devicePath.
...
@@ -121,7 +107,7 @@ The following table describes the API for initializing a modem vendor library.
...
@@ -121,7 +107,7 @@ The following table describes the API for initializing a modem vendor library.
### Debugging and Verification<a name="section5351151517132"></a>
### Debugging and Verification<a name="section5351151517132"></a>
1. Use the [hdc\_std](https://gitee.com/openharmony/docs/blob/master/en/device-dev/subsystems/subsys-toolchain-hdc-guide.md#preparations) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device. For details about how to integrate a library file, see [Integrating Modem Vendor Libraries](#section590mcpsimp).
1. Use the [hdc\_std](https://gitee.com/openharmony/docs/blob/master/en/device-dev/subsystems/subsys-toolchain-hdc-guide.md#preparations) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device. For details about how to integrate a library file, see [Integrating Modem Vendor Libraries](#section590mcpsimp).
```
```
hdc_std file send libril_vendor.z.so /system/lib/
hdc_std file send libril_vendor.z.so /system/lib/
...
@@ -134,7 +120,7 @@ The following table describes the API for initializing a modem vendor library.
...
@@ -134,7 +120,7 @@ The following table describes the API for initializing a modem vendor library.
hdc_std shell reboot
hdc_std shell reboot
```
```
3. Run the **hdc\_std shell hilog** command to view the debug log, and check whether the **RilInitOps\(\)** function is successfully executed. The following debug log is for reference:
3. Run the **hdc\_std shell hilog** command to view the debug log, and check whether the **RilInitOps\(\)** function is successfully executed. The following debug log is for reference:
```
```
01-01 05:13:23.071 136 2319 D 00000/RilAdapterInit: [RilAdapterDispatch-(hril_hdf.c:55)] sbuf IPC obtain test success!
01-01 05:13:23.071 136 2319 D 00000/RilAdapterInit: [RilAdapterDispatch-(hril_hdf.c:55)] sbuf IPC obtain test success!
...
@@ -153,41 +139,16 @@ After receiving a specific telephony service request, RIL Adapter calls the targ
...
@@ -153,41 +139,16 @@ After receiving a specific telephony service request, RIL Adapter calls the targ
The following table describes the APIs for responding to modem service requests, with the dial module as an example.
The following table describes the APIs for responding to modem service requests, with the dial module as an example.
**Table 2** APIs for responding to modem service requests
**Table 2** APIs for responding to modem service requests
| void (\*OnCallReport)(struct ReportInfo reportInfo, const void \*data, size_t dataLen); | Reports the execution result of a service request to RIL Adapter.<br>Input parameters:<br>**reportInfo**: request type<br/>**data**: called number<br/>**dataLen**: data length<br/>Return value: none |
<aname="ul1676502416411"></a><aname="ul1676502416411"></a><ulid="ul1676502416411"><li><strongid="b1576510240416"><aname="b1576510240416"></a><aname="b1576510240416"></a>data</strong>: called number</li></ul>
<aname="ul842034134114"></a><aname="ul842034134114"></a><ulid="ul842034134114"><li><strongid="b1542193411415"><aname="b1542193411415"></a><aname="b1542193411415"></a>dataLen</strong>: data length</li></ul>
<tdclass="cellrowborder"valign="top"width="50.160000000000004%"headers="mcps1.2.3.1.2 "><pid="p328mcpsimp"><aname="p328mcpsimp"></a><aname="p328mcpsimp"></a>Function: Reports the execution result of a service request to RIL Adapter.</p>
<aname="ul18380115494513"></a><aname="ul18380115494513"></a><ulid="ul18380115494513"><li><strongid="b83808549457"><aname="b83808549457"></a><aname="b83808549457"></a>data</strong>: called number</li></ul>
<aname="ul118421156184517"></a><aname="ul118421156184517"></a><ulid="ul118421156184517"><li><strongid="b48421056144519"><aname="b48421056144519"></a><aname="b48421056144519"></a>dataLen</strong>: data length</li></ul>
### How to Develop<a name="section17190412101414"></a>
### How to Develop<a name="section17190412101414"></a>
1. Implement processing of dial requests in the **ReqDial\(\)** API.
1. Implement processing of dial requests in the **ReqDial\(\)** API.
```
```
// Implement the API for processing dial requests.
// Implement the API for processing dial requests.
...
@@ -226,7 +187,7 @@ The following table describes the APIs for responding to modem service requests,
...
@@ -226,7 +187,7 @@ The following table describes the APIs for responding to modem service requests,
}
}
```
```
2. After the modem executes the dial command, report the execution result to RIL Adapter via **OnCallReport\(\)**.
2. After the modem executes the dial command, report the execution result to RIL Adapter via **OnCallReport\(\)**.
```
```
ret = SendCommandLock(cmd, NULL, 0, &pResponse);
ret = SendCommandLock(cmd, NULL, 0, &pResponse);
...
@@ -241,7 +202,7 @@ The following table describes the APIs for responding to modem service requests,
...
@@ -241,7 +202,7 @@ The following table describes the APIs for responding to modem service requests,
### Debugging and Verification<a name="section10207938171413"></a>
### Debugging and Verification<a name="section10207938171413"></a>
1. Use the [hdc\_std](https://gitee.com/openharmony/docs/blob/master/en/device-dev/subsystems/subsys-toolchain-hdc-guide.md#preparations) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device.
1. Use the [hdc\_std](https://gitee.com/openharmony/docs/blob/master/en/device-dev/subsystems/subsys-toolchain-hdc-guide.md#preparations) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device.
```
```
hdc_std file send libril_vendor.z.so /system/lib/
hdc_std file send libril_vendor.z.so /system/lib/
...
@@ -254,7 +215,7 @@ The following table describes the APIs for responding to modem service requests,
...
@@ -254,7 +215,7 @@ The following table describes the APIs for responding to modem service requests,
hdc_std shell reboot
hdc_std shell reboot
```
```
3. Run the **hdc\_std shell** command. Then, run the **./system/bin/ril\_adapter\_test** command, type **1**, and enter the phone number as prompted to test the call function.
3. Run the **hdc\_std shell** command. Then, run the **./system/bin/ril\_adapter\_test** command, type**1**, and enter the phone number as prompted to test the call function.
```
```
hdc_std shell
hdc_std shell
...
@@ -270,7 +231,7 @@ The following table describes the APIs for responding to modem service requests,
...
@@ -270,7 +231,7 @@ The following table describes the APIs for responding to modem service requests,
1
1
```
```
4. Open another terminal window, and run the **hdc\_std shell hilog** command. Then, view the log to check whether **ReqDial\(\)** is successfully executed. The following debug log is for reference:
4. Open another terminal window, and run the **hdc\_std shell hilog** command. Then, view the log to check whether **ReqDial\(\)** is successfully executed. The following debug log is for reference:
| void OnNotifyOps(const char \*s, const char \*smsPdu) | Distributes the events reported by the modem.<br>Input parameters:<br/>**s**: AT command prefix<br/>**smsPdu**: PDU of the SMS message<br/>Return value: none |
<tdclass="cellrowborder"valign="top"width="48%"headers="mcps1.2.3.1.2 "><pid="p423mcpsimp"><aname="p423mcpsimp"></a><aname="p423mcpsimp"></a>Function: Distributes the events reported by the modem.</p>
<aname="ul678053915191"></a><aname="ul678053915191"></a><ulid="ul678053915191"><li><strongid="b14780173912196"><aname="b14780173912196"></a><aname="b14780173912196"></a>s</strong>: AT command prefix</li></ul>
<aname="ul206343434192"></a><aname="ul206343434192"></a><ulid="ul206343434192"><li><strongid="b65891958173518"><aname="b65891958173518"></a><aname="b65891958173518"></a>smsPdu</strong>: PDU of the SMS message</li></ul>
### How to Develop<a name="section16394112401512"></a>
### How to Develop<a name="section16394112401512"></a>
1. Call **OnNotifyOps\(\)** in the g\_reader thread of the modem device node to parse reported modem events. On determining the command type, call **OnXxxReport\(\)** to report the parsed module events to the hril layer.
1. Call **OnNotifyOps\(\)** in the g\_reader thread of the modem device node to parse reported modem events. On determining the command type, call **OnXxxReport\(\)** to report the parsed module events to the hril layer.
```
```
// Parse the data reported by the modem as events proactively reported by the corresponding module.
// Parse the data reported by the modem as events proactively reported by the corresponding module.
...
@@ -352,7 +298,7 @@ The following table describes the API for reporting modem events.
...
@@ -352,7 +298,7 @@ The following table describes the API for reporting modem events.
```
```
1. Distribute the reported events from the **hril** layer to the Telephony Service layer.
1. Distribute the reported events from the **hril** layer to the Telephony Service layer.
```
```
// Report the call status proactively.
// Report the call status proactively.
...
@@ -380,7 +326,7 @@ The following table describes the API for reporting modem events.
...
@@ -380,7 +326,7 @@ The following table describes the API for reporting modem events.
### Debugging and Verification<a name="section16999174401516"></a>
### Debugging and Verification<a name="section16999174401516"></a>
1. Use the [hdc\_std](https://gitee.com/openharmony/docs/blob/master/en/device-dev/subsystems/subsys-toolchain-hdc-guide.md#preparations) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device.
1. Use the [hdc\_std](https://gitee.com/openharmony/docs/blob/master/en/device-dev/subsystems/subsys-toolchain-hdc-guide.md#preparations) tool to connect to a debugging device. Then, run the following command to send the generated **libril\_vendor.z.so** library file to the **/system/lib/** directory of the device.
```
```
hdc_std file send libril_vendor.z.so /system/lib/
hdc_std file send libril_vendor.z.so /system/lib/
...
@@ -393,7 +339,7 @@ The following table describes the API for reporting modem events.
...
@@ -393,7 +339,7 @@ The following table describes the API for reporting modem events.
hdc_std shell reboot
hdc_std shell reboot
```
```
3. Run the **hdc\_std shell** command. Then, run the **./system/bin/ril\_adapter\_test** command, type **1**, and enter the phone number as prompted to test the call function.
3. Run the **hdc\_std shell** command. Then, run the **./system/bin/ril\_adapter\_test** command, type**1**, and enter the phone number as prompted to test the call function.
```
```
hdc_std shell
hdc_std shell
...
@@ -409,7 +355,7 @@ The following table describes the API for reporting modem events.
...
@@ -409,7 +355,7 @@ The following table describes the API for reporting modem events.
1
1
```
```
4. Open another terminal window, and run the **hdc\_std shell hilog** command. Then, view the log to check whether **OnNotifyOps\(\)** is successfully executed. The following debug log is for reference:
4. Open another terminal window, and run the **hdc\_std shell hilog** command. Then, view the log to check whether **OnNotifyOps\(\)** is successfully executed. The following debug log is for reference:
@@ -434,16 +380,16 @@ The following table describes the API for reporting modem events.
...
@@ -434,16 +380,16 @@ The following table describes the API for reporting modem events.
### Development Examples<a name="section33444350167"></a>
### Development Examples<a name="section33444350167"></a>
-**Outgoing Call**
-**Outgoing Call**
The following figure shows the API calling for an outgoing call.
The following figure shows the API calling for an outgoing call.
**Figure 1** Time sequence of API calling for an outgoing call<a name="fig494mcpsimp"></a>
**Figure 1** Time sequence of API calling for an outgoing call<aname="fig494mcpsimp"></a>
When an application initiates an outgoing call, RIL Adapter receives a call request, and the **hril** layer invokes the **ReqDial\(\)** function. In **ReqDial\(\)**, the data passed by the Telephony Service is encapsulated as an AT command and sent to the modem. After executing the dial command, the modem reports the execution result to RIL Adapter through **OnCallReport\(\)**.
When an application initiates an outgoing call, RIL Adapter receives a call request, and the **hril** layer invokes the **ReqDial\(\)** function. In **ReqDial\(\)**, the data passed by the Telephony Service is encapsulated as an AT command and sent to the modem. After executing the dial command, the modem reports the execution result to RIL Adapter through **OnCallReport\(\)**.
```
```
// Callback function pointer of the call module
// Callback function pointer of the call module
...
@@ -513,18 +459,18 @@ The following table describes the API for reporting modem events.
...
@@ -513,18 +459,18 @@ The following table describes the API for reporting modem events.
```
```
-**Incoming Call**
-**Incoming Call**
The following figure shows the API calling of an incoming call.
The following figure shows the API calling of an incoming call.
**Figure 2** Time sequence of API calling for an incoming call<a name="fig556mcpsimp"></a>
**Figure 2** Time sequence of API calling for an incoming call<aname="fig556mcpsimp"></a>
The **g\_reader** thread cyclically reads the messages reported by the modem. When the modem receives an incoming call event, it actively reports the information about the incoming call.
The **g\_reader** thread cyclically reads the messages reported by the modem. When the modem receives an incoming call event, it actively reports the information about the incoming call.
The **g\_reader** thread calls **OnNotifyOps\(\)** to parse the reported information. If the parsed data reported by the modem starts with characters such as **+CRING** or **RING**, it indicates that an incoming call event exists. In this case, the event is reported to RIL Adapter through **OnCallReport\(reportInfo, NULL, 0\)**.
The **g\_reader** thread calls **OnNotifyOps\(\)** to parse the reported information. If the parsed data reported by the modem starts with characters such as **+CRING** or **RING**, it indicates that an incoming call event exists. In this case, the event is reported to RIL Adapter through **OnCallReport\(reportInfo, NULL, 0\)**.
```
```
// Parse the data reported by the modem as events proactively reported by the corresponding module.
// Parse the data reported by the modem as events proactively reported by the corresponding module.
...
@@ -558,7 +504,7 @@ The following table describes the API for reporting modem events.
...
@@ -558,7 +504,7 @@ The following table describes the API for reporting modem events.
Compile the modem vendor library into a dynamic library by using **BUILD.gn**. Upon startup, RIL Adapter loads the dynamic library to the system in dlopen mode and then initializes the library. For details about how to implement vendor library initialization, see [Initializing a Modem Vendor Library](#section211mcpsimp). The following is an example of **BUILD.gn**:
Compile the modem vendor library into a dynamic library by using **BUILD.gn**. Upon startup, RIL Adapter loads the dynamic library to the system in dlopen mode and then initializes the library. For details about how to implement vendor library initialization, see [Initializing a Modem Vendor Library](#section211mcpsimp). The following is an example of**BUILD.gn**:
### Debugging and Verification<a name="section620mcpsimp"></a>
### Debugging and Verification<a name="section620mcpsimp"></a>
1. Compile the code.
1. Compile the code.
2. Check whether **libril\_vendor.z.so** exists in the **/out/{device_name}/telephony/ril\_adapter** directory. If yes, the integration is successful. Otherwise, correct the error and perform debugging and verification again.
2. Check whether **libril\_vendor.z.so** exists in the **/out/{device_name}/telephony/ril\_adapter** directory. If yes, the integration is successful. Otherwise, correct the error and perform debugging and verification again.
|Version|Ubuntu 18.04 or later|libreadline-dev|3.7.5 or later|- pySerial 3.3 or later<br>- Paramiko 2.7.1 or later<br>- Setuptools 40.8.0 or later<br>- rsa4.0 or later|haneWIN NFS Server 1.2.50 or later, or NFS v4 or later| 1.1.0 or later|
| Version | Ubuntu 18.04 or later | libreadline-dev | 3.7.5 or later | - pySerial 3.3 or later<br>- Paramiko 2.7.1 or later<br>- Setuptools 40.8.0 or later<br>- rsa4.0 or later | haneWIN NFS Server 1.2.50 or later, or NFS v4 or later | 1.1.0 or later |
|Description|Provides code build environment.|Plug-in used to read commands.|Language used by the test framework.|- pySerial: supports Python serial port communication. <br>- Paramiko: allows Python to use SSH. <br>- Setuptools: allows Python packages to be created and distributed easily. <br>- rsa: implements RSA encryption in Python.|Enables devices to be connected through the serial port.| A tool that enables devices to be connected through the HarmonyOS Device Connector (HDC).|
| Description | Provides code build environment. | Plug-in used to read commands. | Language used by the test framework. | - pySerial: supports Python serial port communication. <br>- Paramiko: allows Python to use SSH. <br>- Setuptools: allows Python packages to be created and distributed easily. <br>- rsa: implements RSA encryption in Python. | Enables devices to be connected through the serial port. | A tool that enables devices to be connected through the HarmonyOS Device Connector (HDC). |
## Installation Process
## Installation Process
1. Run the following command to install the Linux extended component libreadline:
1. Run the following command to install the Linux extended component libreadline:
...
@@ -68,15 +68,14 @@
...
@@ -68,15 +68,14 @@
nfs-kernel-server is already the newest version (1:1.3.4-2.1ubuntu5.3).
nfs-kernel-server is already the newest version (1:1.3.4-2.1ubuntu5.3).
0 upgraded, 0 newly installed, 0 to remove and 11 not upgraded.
0 upgraded, 0 newly installed, 0 to remove and 11 not upgraded.
```
```
7. Install the HDC tool if the device supports HDC connections. For details about the installation process, see:
7. Install the HDC tool if the device supports HDC connections. For details about the installation process, see [Readme](https://gitee.com/openharmony/developtools_hdc_standard/blob/master/README.md).
| Check whether Python is installed successfully.|Run the **python --version** command.|The Python version is 3.7.5 or later.|
| Whether Python is successfully installed | Run the **python --version** command. | The Python version is 3.7.5 or later. |
| Check whether Python plug-ins are successfully installed.|Go to the **test/developertest** directory and run **start.bat** or **start.sh**.| The **>>>** prompt is displayed.|
| Whether Python plug-ins are successfully installed | Go to the **test/developertest** directory and run **start.bat** or **start.sh**. | The **>>>** prompt is displayed. |
|Check the NFS server status (for the devices that support only serial port output).|Log in to the development board through the serial port and run the **mount** command to mount the NFS.|The file directory can be mounted.|
| NFS server status (for the devices that support only serial port output) | Log in to the development board through the serial port and run the **mount** command to mount the NFS. | The file directory can be mounted. |
|Check whether the HDC tool is successfully installed.|Run the **hdc_std -v** command.|The HDC version is 1.1.0 or later.|
| Whether HDC tool is successfully installed | Run the **hdc_std -v** command. | The HDC version is 1.1.0 or later. |
mr-yx <496043997@qq.com>
