@@ -12,9 +12,9 @@ App permissions are used to protect the following objects:
...
@@ -12,9 +12,9 @@ App permissions are used to protect the following objects:
Without the required permissions, an app cannot access or perform operations on the target object. Permissions must be clearly defined for apps. With well-defined app permissions, the system can standardize the behavior of apps and protect user privacy. Before an app accesses the target object, the target object verifies the app's permissions and denies the access if the app does not have required permissions.
Without the required permissions, an app cannot access or perform operations on the target object. Permissions must be clearly defined for apps. With well-defined app permissions, the system can standardize the behavior of apps and protect user privacy. Before an app accesses the target object, the target object verifies the app's permissions and denies the access if the app does not have required permissions.
Currently, ATM performs app permission verification based on the token identity (Token ID). A token ID identifies an app. The ATM manages app permissions based on the app's token ID.
Currently, ATM verifies app permissions based on the token identity (Token ID). A token ID identifies an app. The ATM manages app permissions based on the app's token ID.
## How to Develop
## Permission Workflow
Determine the permissions required for an app to access data or perform an operation. Declare the required permissions in the app installation package.
Determine the permissions required for an app to access data or perform an operation. Declare the required permissions in the app installation package.
...
@@ -22,13 +22,13 @@ Determine whether the required permissions need to be authorized by users. If ye
...
@@ -22,13 +22,13 @@ Determine whether the required permissions need to be authorized by users. If ye
After the user grants permissions to the app, the app can access the data or perform the operation.
After the user grants permissions to the app, the app can access the data or perform the operation.
The figure below shows the process.
The figure below shows the permission workflow.
## When to Use
## When to Use
### Scenarios
### Example Scenarios
The following describes two common scenarios.
The following describes two common scenarios.
...
@@ -62,7 +62,7 @@ Observe the following principles for permission management:
...
@@ -62,7 +62,7 @@ Observe the following principles for permission management:
To protect user privacy, ATM defines different permission levels based on the sensitivity of the data involved or the security threat of the ability.
To protect user privacy, ATM defines different permission levels based on the sensitivity of the data involved or the security threat of the ability.
### App APL
### App APLs
The ability privilege level (APL) defines the priority of the app permission requested. Apps of different APLs can apply for permissions of different levels.
The ability privilege level (APL) defines the priority of the app permission requested. Apps of different APLs can apply for permissions of different levels.
...
@@ -76,9 +76,9 @@ The table below describes the APLs.
...
@@ -76,9 +76,9 @@ The table below describes the APLs.
By default, apps are of the normal APL.
By default, apps are of the normal APL.
For the app of the system_basic or system_core APL, declare the app APL level in the **apl** field in the app's profile, and use the profile signing tool to generate a certificate when developing the app installation package. For details about the signing process, see [Hapsigner Guide](hapsigntool-guidelines.md).
For the app of the system_basic or system_core APL, declare the app APL in the **apl** field in the app's profile, and use the profile signing tool to generate a certificate when developing the app installation package. For details about the signing process, see [Hapsigner Guide](hapsigntool-guidelines.md).
### Permission Levels
### Levels of Permissions
The permissions open to apps vary with the permission level. The permission levels include the following in ascending order of seniority.
The permissions open to apps vary with the permission level. The permission levels include the following in ascending order of seniority.
...
@@ -121,11 +121,11 @@ If the permission required by an app has higher level than the app's APL, you ca
...
@@ -121,11 +121,11 @@ If the permission required by an app has higher level than the app's APL, you ca
In addition to the preceding [authorization processes](#authorization-processes), you must declare the ACL.
In addition to the preceding [authorization processes](#authorization-processes), you must declare the ACL.
In other words, in addition to declaring the required permissions in the **config.json** file, you must declare the high-level permissions in the app's [profile](accesstoken-guidelines.md#declaring-the-acl). The subsequent steps of authorization are the same.
In other words, in addition to declaring the required permissions in the **config.json** file, you must [declare the ACL](accesstoken-guidelines.md#declaring-the-acl) in the app's profile. The subsequent steps of authorization are the same.
**NOTE**
**NOTICE**
Declare the target ACL in the **acl** field of the app's profile in the app installation package, and generate a certificate using the profile signing tool. For details about the signing process, see [Hapsigner Guide](hapsigntool-guidelines.md).
Declare the target ACL in the **acls** field of the app's profile in the app installation package, and generate a certificate using the profile signing tool. For details about the signing process, see [Hapsigner Guide](hapsigntool-guidelines.md).
## Permission Authorization Modes
## Permission Authorization Modes
...
@@ -149,9 +149,7 @@ Permissions can be classified into the following types based on the authorizatio
...
@@ -149,9 +149,7 @@ Permissions can be classified into the following types based on the authorizatio
### Authorization Processes
### Authorization Processes
The process for an app obtaining the required permissions varies
The process for an app obtaining the required permissions varies depending on the permission authorization mode.
depending on the permission authorization mode.
- For a system_grant permission, you need to [declare the permission](accesstoken-guidelines.md) in the **config.json** file. The permission will be pre-granted when the app is installed.
- For a system_grant permission, you need to [declare the permission](accesstoken-guidelines.md) in the **config.json** file. The permission will be pre-granted when the app is installed.
...
@@ -165,7 +163,7 @@ The procedure is as follows:
...
@@ -165,7 +163,7 @@ The procedure is as follows:
2. Associate the object that requires the permissions in the app with the target permissions. In this way, the user knows the operations to be granted with the specified permissions.
2. Associate the object that requires the permissions in the app with the target permissions. In this way, the user knows the operations to be granted with the specified permissions.
3. Check whether the user has granted the required permissions to the app when the app is running. If yes, the app can access the data or perform the operation. If the user has not granted the permissions to the app, display a dialog box requesting the user authorization when the app attempts to access the data or perform the operation.
3. Check whether the user has granted the required permissions to the app when the app is running. If yes, the app can access the data or perform the operation. If the user has not granted the permissions to the app, display a dialog box requesting the user authorization when the app attempts to access the data.
4. Check the user authorization result. Allow the next step only after the user has granted the permissions to the app.
4. Check the user authorization result. Allow the next step only after the user has granted the permissions to the app.
The Improved Inter-Integrated Circuit (I3C) is a simple and cost-efficient bidirectional 2-wire synchronous serial bus protocol developed by the Mobile Industry Processor Interface (MIPI) Alliance.
Improved Inter-Integrated Circuit (I3C) is a simple and cost-efficient two-wire bidirectional synchronous serial bus protocol developed by the Mobile Industry Processor Interface (MIPI) Alliance.
I3C is backward compatible with legacy Inter-Integrated Circuit (I2C). Moreover, it provides the in-band interrupt (IBI) function and supports hot-join of I3C devices. This eliminates the need for adding an extra interrupt line to implement interrupts in I2C.
I3C is a two-wire bidirectional serial bus, optimized for multiple sensor target devices and controlled by only one I3C controller at a time. It is backward compatible with Inter-Integrated circuit (I2C) target devices, but features higher speed and lower power consumption. Moreover, I3C supports in-band interrupts (IBIs), hot-joins of target devices, and controller switchover. The IBIs over the serial bus eliminates the need for an extra interrupt line to complete interrupts in I2C. I2C devices, I3C target devices, and the I3C secondary controller can co-exist on the same I3C bus.
The I2C device, I3C slave device, and I3C secondary master device can coexist on the I3C bus.
The I3C APIs provide a set of common functions for I3C transfer, including:
The I3C driver APIs provide a set of common functions for I3C transfer, including:
- Opening and closing an I3C controller
- Opening and closing an I3C controller
- Obtaining and setting I3C controller parameters
- Obtaining and setting I3C controller parameters
- Performing custom I3C message transfer by using a message array
- Performing custom I3C message transfer by using a message array
- Requesting and releasing an IBI
- Requesting and releasing an IBI
[Figure 1](#fig1) shows the I3C physical connection.
When there is no start signal on the serial clock (SCL) line, the I3C target device can pull down the serial data (SDA) line to make the controller send an SCL start signal, which initiates an IBI request. If multiple target devices send interrupt requests at the same time, the I3C controller arbitrates the requests based on the target device addresses. The request with a lower address is responded first.
- Dynamic Address Assignment (DAA)
The I3C controller can dynamically allocate addresses to target devices to avoid address conflicts. Before addresses are allocated, each I3C device connected to a I3C bus must be uniquely identified in either of the following ways:
- The device has an I2C compliant static address that can be used by the host.
- The device has a 48-bit temporary ID.
The host must use a 48-bit temporary ID unless the device has a static IP address.
- Common Command Code (CCC)
All I3C devices support CCC. The CCC can be sent to a specific I3C target device or all I3C target devices.
- Bus Characteristic Register (BCR)
Each I3C device connected to an I3C bus has a read-only BCR, which describes the I3C compliant device's role and capabilities for use in DAA and CCC.
- Device Characteristic Register (DCR)
Each I3C device connected to an I3C bus has a read-only DCR, which describes the I3C compliant device type (such as accelerometers, gyroscope, and others) for use in DAA and DCC.
### Working Principles
In the Hardware Driver Foundation (HDF), the I3C module uses the unified service mode for API adaptation. In this mode, a service is used as the I3C manager to handle external access requests in a unified manner. The unified service mode applies when the system has multiple device objects of the same type, for example, when there are more than 10 I3C controllers. If the independent service mode is used in this case, more device nodes need to be configured and more memory resources will be consumed.
Multiple devices, such as I2C target device, I3C target device, and I3C secondary controller, can be connected to an I3C bus. However, the I3C bus must have only one controller.
The I3C messages are of the I3cMsg type. Each message structure indicates a read or write operation. A message array can be used to perform multiple read or write operations.
<tdclass="cellrowborder"valign="top"width="50%"><p>Transmission mode, where the value <b>0</b> indicates the I2C mode, <b>1</b> indicates the I3C mode, and <b>2</b> indicates transmission of the Common Command Code (CCC).
The I3C messages are of the I3cMsg type. Each message structure indicates a read or write operation. A message array is used to perform multiple read or write operations.
>- The device address in the **I3cMsg** structure does not contain the read/write flag bit. The read/write information is passed by the read/write control bit in the member variable **flags**.
>- The device address in the **I3cMsg** structure does not contain the read/write flag bit. The read/write information is passed by the read/write control bit in the member variable **flags**.
>- The **I3cTransfer()** function does not limit the number of message structures or the length of data in each message structure. The I3C controller determines these two limits.
>- The **I3cTransfer()** function does not limit the number of message structures or the length of data in each message structure. The I3C controller determines these two limits.
>- Using **I3cTransfer()** may cause the system to sleep. Do not call it in the interrupt context.
>- Using **I3cTransfer()** may cause the system to sleep. Do not call it in the interrupt context.
### Obtaining the I3C Controller Configuration<a name="section7"></a>
#### Obtaining the I3C Controller Configuration
Call **I3cGetConfig()** to obtain the configuration of an I3C controller.
In the Hardware Driver Foundation \(HDF\), the Universal Asynchronous Receiver/Transmitter \(UART\) uses the independent service mode for API adaptation. In this mode, each device independently publishes a device service to handle external access requests. After receiving an access request from an API, the device manager extracts the parameters in the request to call the internal method of the target device. In the independent service mode, the service management capabilities of the HDF Device Manager can be directly used. However, you need to configure a device node for each device, which increases the memory usage.
## Overview
**Figure 1** Independent service mode<aname="fig1474518243468"></a>
In the Hardware Driver Foundation (HDF), the Universal Asynchronous Receiver/Transmitter (UART) uses the independent service mode for API adaptation. In this mode, each device independently publishes a service to process external access requests. When receiving an access request, the HDF DeviceManager extracts parameters from the request to call the internal APIs of the target device. In the independent service mode, the HDF DeviceManager provides service management capabilities. However, you need to configure a node for each device, which increases memory usage.
| Deinit | **host**: structure pointer to the UART controller at the core layer.| –| HDF_STATUS| Deinitializes a UART device.|
</th>
| Read | **host**: structure pointer to the UART controller at the core layer.<br>**size**: data size, which is of the uint32_t type.| **data**: pointer to the output data. The value is of the uint8_t type.| HDF_STATUS| Reads data.|
| Write | **host**: structure pointer to the UART controller at the core layer.<br>**data**: pointer to the input data. The value is of the uint8_t type.<br>**size**: data size, which is of the uint32_t type.| –| HDF_STATUS| Writes data.|
</th>
| SetBaud | **host**: structure pointer to the UART controller at the core layer.<br>**baudRate**: pointer to the input baud rate. The value is of the uint32_t type. | –| HDF_STATUS| Sets the baud rate.|
| GetBaud | **host**: structure pointer to the UART controller at the core layer.| **baudRate**: pointer to the output baud rate. The value is of the uint32_t type.| HDF_STATUS| Obtains the current baud rate.|
</th>
| GetAttribute | **host**: structure pointer to the UART controller at the core layer.| **attribute**: structure pointer to the UART attributes. For details, see **UartAttribute** in **uart_if.h**.| HDF_STATUS| Obtains UART attributes.|
| SetAttribute | **host**: structure pointer to the UART controller at the core layer.<br>**attribute**: structure pointer to the UART attributes to set.| –| HDF_STATUS| Sets UART attributes.|
</th>
| SetTransMode | **host**: structure pointer to the UART controller at the core layer.<br>**mode**: transfer mode to set. For details, see **UartTransMode** in **uart_if.h**.| –| HDF_STATUS| Sets the UART transfer mode.|
</tr>
| PollEvent | **host**: structure pointer to the UART controller at the core layer.<br>**filep**: void pointer to a file.<br>**table**: void pointer to poll_table.| –| HDF_STATUS| Polls for pending events.|
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p53082134713"><aname="p53082134713"></a><aname="p53082134713"></a><strongid="b231216565514"><aname="b231216565514"></a><aname="b231216565514"></a>host</strong>: structure pointer to the UART controller at the core layer.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.5 "><pid="p173032124713"><aname="p173032124713"></a><aname="p173032124713"></a>Initializes the UART device.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p14301921174718"><aname="p14301921174718"></a><aname="p14301921174718"></a><strongid="b7500154935512"><aname="b7500154935512"></a><aname="b7500154935512"></a>host</strong>: structure pointer to the UART controller at the core layer.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.5 "><pid="p203162110478"><aname="p203162110478"></a><aname="p203162110478"></a>Deinitializes the UART device.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p117841019115819"><aname="p117841019115819"></a><aname="p117841019115819"></a><strongid="b8784519205820"><aname="b8784519205820"></a><aname="b8784519205820"></a>host</strong>: structure pointer to the UART controller at the core layer.</p>
<pid="p13318214472"><aname="p13318214472"></a><aname="p13318214472"></a><strongid="b76471214185712"><aname="b76471214185712"></a><aname="b76471214185712"></a>size</strong>: data size, which is of the uint32_t type.</p>
</td>
<tdclass="cellrowborder"valign="top"width="19.98%"headers="mcps1.2.6.1.3 "><pid="p1313213473"><aname="p1313213473"></a><aname="p1313213473"></a><strongid="b1372195311577"><aname="b1372195311577"></a><aname="b1372195311577"></a>data</strong>: uint8_t pointer to the output data.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p11377332105815"><aname="p11377332105815"></a><aname="p11377332105815"></a><strongid="b193771532135811"><aname="b193771532135811"></a><aname="b193771532135811"></a>host</strong>: structure pointer to the UART controller at the core layer.</p>
<pid="p174031635125817"><aname="p174031635125817"></a><aname="p174031635125817"></a><strongid="b540373505819"><aname="b540373505819"></a><aname="b540373505819"></a>data</strong>: pointer to the input data, which is of the uint8_t type.</p>
<pid="p15311321204719"><aname="p15311321204719"></a><aname="p15311321204719"></a><strongid="b15686191305911"><aname="b15686191305911"></a><aname="b15686191305911"></a>size</strong>: data size, which is of the uint32_t type.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p863959125812"><aname="p863959125812"></a><aname="p863959125812"></a><strongid="b11631159145818"><aname="b11631159145818"></a><aname="b11631159145818"></a>host</strong>: structure pointer to the UART controller at the core layer. </p>
<pid="p3321521134717"><aname="p3321521134717"></a><aname="p3321521134717"></a><strongid="b16745461412"><aname="b16745461412"></a><aname="b16745461412"></a>baudRate</strong>: pointer to the input baud rate, which is of the uint32_t type.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.5 "><pid="p7321521114711"><aname="p7321521114711"></a><aname="p7321521114711"></a>Sets the baud rate.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p132821184711"><aname="p132821184711"></a><aname="p132821184711"></a><strongid="b4510164912550"><aname="b4510164912550"></a><aname="b4510164912550"></a>host</strong>: structure pointer to the UART controller at the core layer.</p>
</td>
<tdclass="cellrowborder"valign="top"width="19.98%"headers="mcps1.2.6.1.3 "><pid="p63262112477"><aname="p63262112477"></a><aname="p63262112477"></a><strongid="b1097116311227"><aname="b1097116311227"></a><aname="b1097116311227"></a>baudRate</strong>: uint32_t pointer to the output baud rate.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.5 "><pid="p163232154717"><aname="p163232154717"></a><aname="p163232154717"></a>Obtains the current baud rate.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p15331721164715"><aname="p15331721164715"></a><aname="p15331721164715"></a><strongid="b1518144935510"><aname="b1518144935510"></a><aname="b1518144935510"></a>host</strong>: structure pointer to the UART controller at the core layer.</p>
</td>
<tdclass="cellrowborder"valign="top"width="19.98%"headers="mcps1.2.6.1.3 "><pid="p23313219472"><aname="p23313219472"></a><aname="p23313219472"></a><strongid="b16392039333"><aname="b16392039333"></a><aname="b16392039333"></a>attribute</strong>: structure pointer to the output attributes. For details, see <strongid="b524111513416"><aname="b524111513416"></a><aname="b524111513416"></a>UartAttribute</strong> in <strongid="b47291920444"><aname="b47291920444"></a><aname="b47291920444"></a>uart_if.h</strong>.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p147011110590"><aname="p147011110590"></a><aname="p147011110590"></a><strongid="b070151125915"><aname="b070151125915"></a><aname="b070151125915"></a>host</strong>: structure pointer to the UART controller at the core layer.</p>
<pid="p16331210473"><aname="p16331210473"></a><aname="p16331210473"></a><strongid="b1497919522420"><aname="b1497919522420"></a><aname="b1497919522420"></a>attribute</strong>: structure pointer to the input attributes.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p1821251985919"><aname="p1821251985919"></a><aname="p1821251985919"></a><strongid="b1121271918594"><aname="b1121271918594"></a><aname="b1121271918594"></a>host</strong>: structure pointer to the UART controller at the core layer.</p>
<pid="p1034621104717"><aname="p1034621104717"></a><aname="p1034621104717"></a><strongid="b104767219711"><aname="b104767219711"></a><aname="b104767219711"></a>mode</strong>: transmission mode, which is an enumerated value. For details, see <strongid="b2101455871"><aname="b2101455871"></a><aname="b2101455871"></a>UartTransMode</strong> in <strongid="b99657016815"><aname="b99657016815"></a><aname="b99657016815"></a>uart_if.h</strong>).</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.2 "><pid="p31278367592"><aname="p31278367592"></a><aname="p31278367592"></a><strongid="b1127163625919"><aname="b1127163625919"></a><aname="b1127163625919"></a>host</strong>: structure pointer to the UART controller at the core layer.</p>
<pid="p16654144015591"><aname="p16654144015591"></a><aname="p16654144015591"></a><strongid="b86541440135917"><aname="b86541440135917"></a><aname="b86541440135917"></a>filep</strong>: void pointer to a file.</p>
<pid="p634121104712"><aname="p634121104712"></a><aname="p634121104712"></a><strongid="b163481035141514"><aname="b163481035141514"></a><aname="b163481035141514"></a>table</strong>: void pointer to a poll_table.</p>
<tdclass="cellrowborder"valign="top"width="20%"headers="mcps1.2.6.1.5 "><pid="p63522174720"><aname="p63522174720"></a><aname="p63522174720"></a>Polls for pending events.</p>
</td>
</tr>
</tbody>
</table>
## How to Develop<a name="section944397404154520"></a>
The UART module adaptation involves the following steps:
The UART module adaptation involves the following steps:
1. Instantiate the driver entry.
1. Instantiate the driver entry.
- Instantiate the **HdfDriverEntry** structure.
- Instantiate the **HdfDriverEntry** structure.
- Call **HDF\_INIT** to register the **HdfDriverEntry** instance with the HDF.
- Call **HDF_INIT** to register the **HdfDriverEntry** instance with the HDF.
2. Configure attribute files.
2. Configure attribute files.
- Add the **deviceNode** information to the **device\_info.hcs** file.
- Add the **deviceNode** information to the **device_info.hcs** file.
-\(Optional\) Add the **uart\_config.hcs** file.
- (Optional) Add the **uart_config.hcs** file.
3. Instantiate the UART controller object.
3. Instantiate the UART controller object.
- Initialize **UartHost**.
- Initialize **UartHost**.
- Instantiate **UartHostMethod** in the **UartHost** object.
- Instantiate **UartHostMethod** in the **UartHost** object.
(Optional) For new drivers, verify the basic functions, such as the UART status control and response to interrupts.
>For details, see [Available APIs](#available-apis).
## Development Example
4. Debug the driver.
The following uses **uart_hi35xx.c** as an example to present the information required for implementing device functions.
-\(Optional\) For new drivers, verify the basic functions, such as the UART control status and response to interrupts.
1. Instantiate the driver entry.<br/>The driver entry must be a global variable of the **HdfDriverEntry** type (defined in **hdf_device_desc.h**), and the value of **moduleName** must be the same as that in **device_info.hcs**. In the HDF, the start address of each **HdfDriverEntry** object of all loaded drivers is collected to form a segment address space similar to an array for the upper layer to invoke.
Generally, the HDF calls the **Bind** function and then the **Init** function to load a driver. If **Init** fails to be called, the HDF calls **Release** to release driver resources and exit.
## Development Example<a name="section774610224154520"></a>
UART driver entry example:
The following uses **uart\_hi35xx.c** as an example to present the contents that need to be provided by the vendor to implement device functions.
1. Instantiate the driver entry. The driver entry must be a global variable of the **HdfDriverEntry** type \(defined in **hdf\_device\_desc.h**\), and the value of **moduleName** must be the same as that in **device\_info.hcs**. In the HDF, the start address of each **HdfDriverEntry** object of all loaded drivers is collected to form a segment address space similar to an array for the upper layer to invoke.
Generally, HDF calls the **Bind** function and then the **Init** function to load a driver. If **Init** fails to be called, HDF calls **Release** to release driver resources and exit.
- UART driver entry reference
```
```
struct HdfDriverEntry g_hdfUartDevice = {
struct HdfDriverEntry g_hdfUartDevice = {
.moduleVersion = 1,
.moduleVersion = 1,
.moduleName = "HDF_PLATFORM_UART", // (Mandatory) This parameter must be the same as that in the .hcs file.
.moduleName = "HDF_PLATFORM_UART", // (Mandatory) The value must be the same as that in the .hcs file.
.Bind = HdfUartDeviceBind, // See the Bind function.
.Bind = HdfUartDeviceBind, // See the Bind function.
.Init = HdfUartDeviceInit, // See the Init function.
.Init = HdfUartDeviceInit, // See the Init function.
.Release = HdfUartDeviceRelease, //See the Release function.
.Release = HdfUartDeviceRelease, //See the Release function.
...
@@ -209,11 +89,10 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
...
@@ -209,11 +89,10 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
HDF_INIT(g_hdfUartDevice);
HDF_INIT(g_hdfUartDevice);
```
```
2. Add the **deviceNode** information to the **device\_info.hcs** file and configure the device attributes in the **uart\_config.hcs** file. The **deviceNode** information is related to registration of the driver entry. The device attribute values are closely related to the default values or value ranges of the **UartHost** members at the core layer.
2. Add the **deviceNode** information to the **device_info.hcs** file and configure the device attributes in the **uart_config.hcs** file.<br> The **deviceNode** information is related to registration of the driver entry. The device attribute values are closely related to the default values or value ranges of the **UartHost** members at the core layer.
In this example, there is only one UART controller. If there are multiple UART controllers, you need to add the **deviceNode** information to the **device_info** file and add the corresponding device attributes to the **uart_config** file for each controller.
-**device_info.hcs** configuration example
In this example, there is only one UART controller. If there are multiple UART controllers, you need to add the **deviceNode** information to the **device\_info** file and add the corresponding device attributes to the **uart\_config** file.
- **device\_info.hcs** configuration reference
```
```
root {
root {
...
@@ -224,15 +103,15 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
...
@@ -224,15 +103,15 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
priority = 50;
priority = 50;
device_uart :: device {
device_uart :: device {
device0 :: deviceNode {
device0 :: deviceNode {
policy = 1; // The value 1 indicates that the driver publishes kernel-mode services. The value 2 indicates that the driver publishes user-mode services.
policy = 1; // The driver publishes services only for kernel-mode processes.
priority = 40; // Driver startup priority
priority = 40; // Driver startup priority.
permission = 0644; // Permission for the driver to create a device node
permission = 0644; // Permission for the driver to create a device node.
moduleName = "HDF_PLATFORM_UART"; // Driver name, which must be the same as that of moduleName in the driver entry structure.
moduleName = "HDF_PLATFORM_UART"; // Driver name, which must be the same as moduleName in the HdfDriverEntry structure.
serviceName = "HDF_PLATFORM_UART_0";// Unique name of the service published by the driver. The name is in the HDF_PLATFORM_UART_X format. X indicates the UART controller number.
serviceName = "HDF_PLATFORM_UART_0";// Unique name of the service published by the driver. The name is in the HDF_PLATFORM_UART_X format. X indicates the UART controller number.
deviceMatchAttr = "hisilicon_hi35xx_uart_0"; // Keyword matching the private data of the driver. The value must be the same as that of match_attr in the private data configuration table of the driver.
deviceMatchAttr = "hisilicon_hi35xx_uart_0"; // Keyword for matching the private data of the driver. The value must be the same as that of match_attr in the private data configuration table of the driver.
}
}
device1 :: deviceNode {
device1 :: deviceNode {
policy = 2;
policy = 2; // The driver publishes services for both kernel- and user-mode processes.
permission = 0644;
permission = 0644;
priority = 40;
priority = 40;
moduleName = "HDF_PLATFORM_UART";
moduleName = "HDF_PLATFORM_UART";
...
@@ -246,20 +125,21 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
...
@@ -246,20 +125,21 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
}
}
```
```
- **uart\_config.hcs** configuration reference
-**uart_config.hcs** configuration example
```
```
root {
root {
platform {
platform {
template uart_controller {// Template configuration. In the template, you can configure the common parameters shared by service nodes.
template uart_controller { // Template configuration. In the template, you can configure the common parameters shared by device nodes.
match_attr = "";
match_attr = "";
num = 0; // (Mandatory) Device number
num = 0; // (Mandatory) Device number
baudrate = 115200; // (Mandatory) Baud rate. Set the value based on service requirements.
baudrate = 115200; // (Mandatory) Baud rate. Set the value based on service requirements.
fifoRxEn = 1; // (Mandatory) Enable the receive of FIFOs.
fifoRxEn = 1; // (Mandatory) Enable FIFOs to be received.
fifoTxEn = 1; // (Mandatory) Enable the transmit of FIFOs.
fifoTxEn = 1; // (Mandatory) Enable FIFOs to be transferred.
flags = 4; // (Mandatory) Flag signal
flags = 4; // (Mandatory) Flag signal.
regPbase = 0x120a0000; // (Mandatory) Used for address mapping.
regPbase = 0x120a0000; // (Mandatory) Used for address mapping.
interrupt = 38; // (Mandatory) Interrupt number
interrupt = 38; // (Mandatory) Interrupt number.
iomemCount = 0x48; // (Mandatory) Used for address mapping.
iomemCount = 0x48; // (Mandatory) Used for address mapping.
}
}
controller_0x120a0000 :: uart_controller {
controller_0x120a0000 :: uart_controller {
...
@@ -273,42 +153,43 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
...
@@ -273,42 +153,43 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
match_attr = "hisilicon_hi35xx_uart_1";
match_attr = "hisilicon_hi35xx_uart_1";
}
}
...
...
//(Optional) Add nodes to the device_info.hcs file as required.
//(Optional) Add more controller data. The node information must have been added in the device_info.hcs file.
}
}
}
}
```
```
3. Initialize the **UartHost** object at the core layer, including initializing the vendor custom structure \(transferring parameters and data\), instantiating **UartHostMethod**\(used to call underlying functions of the driver\) in **UartHost**, and implementing the **HdfDriverEntry** member functions \(**Bind**, **Init**, and **Release**\).
3. Initialize the **UartHost** object at the core layer, including defining a custom structure (to pass parameters and data) and implementing the **HdfDriverEntry** member functions (**Bind**, **Init**, and **Release**) to instantiate **UartHostMethod** in **UartHost** (so that the underlying driver functions can be called).
- Custom structure reference
- Defining a custom structure
To the driver, the custom structure holds parameters and data. The **DeviceResourceIface** method provided by the HDF reads the values in the **uart_config.hcs** file to initialize the members in the custom structure and passes important parameters, such as the device number, to the **UartHost** object at the core layer.
To the driver, the custom structure carries parameters and data. The values in the **uart\_config.hcs** file are read by HDF, and the structure members are initialized through **DeviceResourceIface**. Some important values, such as the device number, are also passed to the objects at the core layer.
```
```
struct UartPl011Port {// Structure related to the API
struct UartPl011Port { // Interface structure
int32_t enable;
int32_t enable;
unsigned long physBase; // Physical address
unsigned long physBase; // Physical address
uint32_t irqNum; // Interrupt number
uint32_t irqNum; // Interrupt number
uint32_t defaultBaudrate;// Default baud rate
uint32_t defaultBaudrate;// Default baud rate
uint32_t flags; // Flag signal, which is related to the following three macros.
uint32_t flags; // Flags related to the following three macros.
wait_queue_head_t wait; // Queuing signal related to conditional variables
wait_queue_head_t wait; // Queuing signal related to conditional variables
int32_t count; // Data count
int32_t count; // Data count
int32_t state; // UART controller status
int32_t state; // UART controller state
#define UART_STATE_NOT_OPENED 0
#define UART_STATE_NOT_OPENED 0
#define UART_STATE_OPENING 1
#define UART_STATE_OPENING 1
#define UART_STATE_USEABLE 2
#define UART_STATE_USEABLE 2
#define UART_STATE_SUSPENED 3
#define UART_STATE_SUSPENDED 3
uint32_t flags; // Status flag
uint32_t flags; // Status flags
#define UART_FLG_DMA_RX (1 << 0)
#define UART_FLG_DMA_RX (1 << 0)
#define UART_FLG_DMA_TX (1 << 1)
#define UART_FLG_DMA_TX (1 << 1)
#define UART_FLG_RD_BLOCK (1 << 2)
#define UART_FLG_RD_BLOCK (1 << 2)
...
@@ -317,21 +198,21 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
...
@@ -317,21 +198,21 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
void *private; // It stores the pointer to the start address of UartPl011Port for easy invocation.
void *private; // It stores the pointer to the start address of UartPl011Port for easy invocation.
};
};
// UartHost is the controller structure at the core layer. Its members are assigned with values by using the Init function.
// UartHost is the controller structure at the core layer. The Init function assigns values to the members of UartHost.
struct UartHost {
struct UartHost {
struct IDeviceIoService service;
struct IDeviceIoService service;
struct HdfDeviceObject *device;
struct HdfDeviceObject *device;
uint32_t num;
uint32_t num;
OsalAtomic atom;
OsalAtomic atom;
void *priv; // It stores the pointer to the start address of the vendor's custom structure for invoking the structure.
void *priv; // It stores the pointer to the start address of the vendor's custom structure for easy invocation.
struct UartHostMethod *method; // Hook at the core layer. The vendor needs to implement and instantiate its member functions.
struct UartHostMethod *method; // Hook at the core layer. You need to implement and instantiate its member functions.
};
};
```
```
- Instantiating **UartHostMethod** in **UartHost** (other members are initialized by **Bind**)
- Instantiate the callback function structure **UartHostMethod** in **UartHost**. Other members are initialized by using the **Bind** function.
```
```
// Example in pwm_hi35xx.c: instantiate the hook.
// Example in uart_hi35xx.c: instantiate the hook.
struct UartHostMethod g_uartHostMethod = {
struct UartHostMethod g_uartHostMethod = {
.Init = Hi35xxInit,
.Init = Hi35xxInit,
.Deinit = Hi35xxDeinit,
.Deinit = Hi35xxDeinit,
...
@@ -346,62 +227,32 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
...
@@ -346,62 +227,32 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
};
};
```
```
- Bind function
-**Bind** function
Input parameters:
Input parameter:
**HdfDeviceObject**, an interface parameter exposed by the driver, contains the .hcs configuration file information.
**HdfDeviceObject**, an interface parameter exposed by the driver, contains the .hcs information.
Return values:
Return value:
HDF\_STATUS \(The following table lists some status. For details about other status, see **HDF\_STATUS** in the **//drivers/framework/include/utils/hdf\_base.h** file.\)
HDF_STATUS<br/>The table below describes some status. For more information, see **HDF_STATUS** in the **/drivers/framework/include/utils/hdf_base.h** file.
**Table 2** Input parameters and return values of the Bind function
port = (struct UartPl011Port *)OsalMemCalloc(sizeof(struct UartPl011Port));// [2]
port = (struct UartPl011Port *)OsalMemCalloc(sizeof(struct UartPl011Port));// Step 2
...
...
udd->ops = Pl011GetOps();// [3] Perform operations, such as starting or stopping a device, setting attributes, and sending data.
udd->ops = Pl011GetOps(); // Step 3 Hook the functions for starting or stopping a device, setting attributes, and sending data.
udd->recv = PL011UartRecvNotify;// [4] Connect to the data receiving notification function (conditional lock mechanism).
udd->recv = PL011UartRecvNotify;// Step 4 Hook the data receiving notification function (conditional lock mechanism).
udd->count = 0; // [5]
udd->count = 0; // Step 5
port->udd = udd; // [6] Enable conversion between UartPl011Port and UartDriverData.
port->udd = udd; // Step 6 Enable conversion between UartPl011Port and UartDriverData.
ret = UartGetConfigFromHcs(port, device->property);// (Mandatory) Transfer the attributes of HdfDeviceObject to the vendor custom structure.
ret = UartGetConfigFromHcs(port, device->property);// Pass the attributes of HdfDeviceObject to the custom structure.
// The sample code is as follows:
// The sample code is as follows:
...
...
udd->private = port; // [7]
udd->private = port; // Step 7
host->priv = udd; // (Mandatory) Enable conversion between UartHost and UartDriverData.
host->priv = udd; // (Mandatory) Enable conversion between UartHost and UartDriverData.
host->num = udd->num;// (Mandatory) UART device number
host->num = udd->num; // (Mandatory) UART device number
UartAddDev(host); // (Mandatory) Function in uart_dev.c at the core layer used to register a character device node with the VFS so that the UART can be accessed in user mode through this virtual file node.
UartAddDev(host); // (Mandatory) Function (in uart_dev.c) used to register a character device node to the VFS so that the UART can be accessed through the virtual file node in user mode.
return HDF_SUCCESS;
return HDF_SUCCESS;
}
}
...
@@ -488,7 +340,7 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
...
@@ -488,7 +340,7 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
// Extract the value based on the request parameter and assign the value to the vendor custom structure.
// Extract the values based on the request and assign the values to the custom structure.
if (iface->GetUint32(node, "num", &udd->num, 0) != HDF_SUCCESS) {
if (iface->GetUint32(node, "num", &udd->num, 0) != HDF_SUCCESS) {
HDF_LOGE("%s: read busNum fail", __func__);
HDF_LOGE("%s: read busNum fail", __func__);
return HDF_FAILURE;
return HDF_FAILURE;
...
@@ -497,20 +349,20 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
...
@@ -497,20 +349,20 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
return 0;
return 0;
}
}
```
```
-**Release** function
- Release function
Input parameter:
Input parameters:
**HdfDeviceObject**, an interface parameter exposed by the driver, contains the .hcs configuration file information.
**HdfDeviceObject**, an interface parameter exposed by the driver, contains the .hcs information.
Return values:
Return value:
–
No value is returned.
Function description:
Function description:
Releases the memory and deletes the controller. This function assigns a value to the **Release** API in the driver entry structure. When the HDF fails to call the **Init** function to initialize the driver, the **Release** function can be called to release driver resources. All forced conversion operations for obtaining the corresponding object can be successful only when the **Init** function has the corresponding value assignment operations.
Releases the memory and deletes the controller. This function assigns values to the **Release** API in the driver entry structure. When the HDF fails to call the **Init** function to initialize the driver, the **Release** function can be called to release driver resources. All forced conversion operations for obtaining the corresponding object can be successful only when **Init()** has the corresponding value assignment operations.
@@ -520,7 +372,7 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
...
@@ -520,7 +372,7 @@ The following uses **uart\_hi35xx.c** as an example to present the contents th
host = UartHostFromDevice(device);// Forcibly convert HdfDeviceObject to UartHost by using service. For details about the value assignment, see the Bind function.
host = UartHostFromDevice(device);// Forcibly convert HdfDeviceObject to UartHost by using service. For details about the value assignment, see the Bind function.
...
...
if (host->priv != NULL) {
if (host->priv != NULL) {
Hi35xxDetach(host); // Memory release function customized by the vendor. For details, see the following description.
