提交 87feb56e 编写于 作者: A Annie_wang

update docs

Signed-off-by: NAnnie_wang <annie.wangli@huawei.com>
上级 49669a01
...@@ -11,9 +11,9 @@ The GPIO APIs define a set of standard functions for performing operations on GP ...@@ -11,9 +11,9 @@ The GPIO APIs define a set of standard functions for performing operations on GP
- Reading and writing the pin level, which can be low or high - Reading and writing the pin level, which can be low or high
- Setting the interrupt service routine (ISR) function and interrupt trigger mode for a pin - Setting an interrupt service routine (ISR) function and interrupt trigger mode for a pin
- Enabling or disabling interrupts for a pin - Enabling or disabling pin interrupts
## Available APIs ## Available APIs
...@@ -37,7 +37,7 @@ The GPIO APIs define a set of standard functions for performing operations on GP ...@@ -37,7 +37,7 @@ The GPIO APIs define a set of standard functions for performing operations on GP
The figure below shows the general GPIO development process. In the APIs, a GPIO pin is specified by the pin number. The figure below shows the general GPIO development process. In the APIs, a GPIO pin is specified by the pin number.
**Figure 1** Using GPIO driver APIs **Figure 1** Using GPIO driver APIs
![](figures/using-GPIO-process.png "using-gpio-process.png") ![](figures/using-GPIO-process.png "using-gpio-process.png")
...@@ -70,9 +70,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont ...@@ -70,9 +70,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont
- Set the GPIO pin direction. - Set the GPIO pin direction.
Before performing read/write operations on a GPIO pin, call **GpioSetDir()** to set the pin direction. Before performing read/write operations on a GPIO pin, call **GpioSetDir()** to set the pin direction.
```c
int32_t GpioSetDir(uint16_t gpio, uint16_t dir); int32_t GpioSetDir(uint16_t gpio, uint16_t dir);
```
**Table 2** Description of GpioSetDir **Table 2** Description of GpioSetDir
...@@ -88,9 +86,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont ...@@ -88,9 +86,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont
Call **GpioRead()** to read the level of a GPIO pin. Call **GpioRead()** to read the level of a GPIO pin.
```c int32_t GpioRead(uint16_t gpio, uint16_t \*val);
int32_t GpioRead(uint16_t gpio, uint16_t *val);
```
**Table 3** Description of GpioRead **Table 3** Description of GpioRead
...@@ -104,10 +100,8 @@ The method for determining the GPIO pin number varies depending on the GPIO cont ...@@ -104,10 +100,8 @@ The method for determining the GPIO pin number varies depending on the GPIO cont
Call **GpioWrite()** to write the level for a GPIO pin. Call **GpioWrite()** to write the level for a GPIO pin.
```c
int32_t GpioWrite(uint16_t gpio, uint16_t val); int32_t GpioWrite(uint16_t gpio, uint16_t val);
```
**Table 4** Description of GpioWrite **Table 4** Description of GpioWrite
| **Parameter**| **Description**| | **Parameter**| **Description**|
...@@ -120,7 +114,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont ...@@ -120,7 +114,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont
Sample code: Sample code:
``` ```
int32_t ret; int32_t ret;
uint16_t val; uint16_t val;
...@@ -150,10 +144,8 @@ The method for determining the GPIO pin number varies depending on the GPIO cont ...@@ -150,10 +144,8 @@ The method for determining the GPIO pin number varies depending on the GPIO cont
Call **GpioSetIrq()** to set the ISR function for a GPIO pin. Call **GpioSetIrq()** to set the ISR function for a GPIO pin.
```c int32_t GpioSetIrq(uint16_t gpio, uint16_t mode, GpioIrqFunc func, void \*arg);
int32_t GpioSetIrq(uint16_t gpio, uint16_t mode, GpioIrqFunc func, void *arg);
```
**Table 5** Description of GpioSetIrq **Table 5** Description of GpioSetIrq
| **Parameter**| **Description**| | **Parameter**| **Description**|
...@@ -171,9 +163,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont ...@@ -171,9 +163,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont
If the ISR function is no longer required, call **GpioUnsetIrq()** to cancel it. If the ISR function is no longer required, call **GpioUnsetIrq()** to cancel it.
```c int32_t GpioUnsetIrq(uint16_t gpio, void \*arg);
int32_t GpioUnsetIrq(uint16_t gpio, void *arg);
```
**Table 6** Description of GpioUnsetIrq **Table 6** Description of GpioUnsetIrq
...@@ -187,9 +177,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont ...@@ -187,9 +177,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont
After the ISR function is set, call **GpioEnableIrq()** to enable interrupts for the GPIO pin. After the ISR function is set, call **GpioEnableIrq()** to enable interrupts for the GPIO pin.
```c
int32_t GpioEnableIrq(uint16_t gpio); int32_t GpioEnableIrq(uint16_t gpio);
```
**Table 7** Description of GpioEnableIrq **Table 7** Description of GpioEnableIrq
...@@ -205,9 +193,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont ...@@ -205,9 +193,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont
You can call **GpioDisableIrq** to disable interrupts for the pin. You can call **GpioDisableIrq** to disable interrupts for the pin.
```c
int32_t GpioDisableIrq(uint16_t gpio); int32_t GpioDisableIrq(uint16_t gpio);
```
**Table 8** Description of GpioDisableIrq **Table 8** Description of GpioDisableIrq
...@@ -220,7 +206,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont ...@@ -220,7 +206,7 @@ The method for determining the GPIO pin number varies depending on the GPIO cont
Sample code: Sample code:
``` ```
/* Set the ISR function. */ /* Set the ISR function. */
int32_t MyCallBackFunc(uint16_t gpio, void *data) int32_t MyCallBackFunc(uint16_t gpio, void *data)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册