forked from OpenHarmony / docs

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

克隆/下载

i2c_if-h.md 5.58 KB

# i2c\_if.h<a name="ZH-CN_TOPIC_0000001054479535"></a>

## **Overview**<a name="section1136701475093525"></a>

**Related Modules:**

[I2C](I2C.md)

**Description:**

Declares the standard I2C interface functions.

**Since:**

1.0

## **Summary**<a name="section487381195093525"></a>

## Data Structures<a name="nested-classes"></a>

<a name="table491107091093525"></a>
<table><thead align="left"><tr id="row571139557093525"><th class="cellrowborder" valign="top" width="50%" id="mcps1.1.3.1.1"><p id="p2010388261093525"><a name="p2010388261093525"></a><a name="p2010388261093525"></a>Data Structure Name</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.1.3.1.2"><p id="p908546142093525"><a name="p908546142093525"></a><a name="p908546142093525"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row322315665093525"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.1 "><p id="p380607614093525"><a name="p380607614093525"></a><a name="p380607614093525"></a><a href="I2cMsg.md">I2cMsg</a></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.2 "><p id="p1892381275093525"><a name="p1892381275093525"></a><a name="p1892381275093525"></a>Defines the I2C transfer message used during custom transfers. </p>
</td>
</tr>
</tbody>
</table>

## Enumerations<a name="enum-members"></a>

<a name="table1386422173093525"></a>
<table><thead align="left"><tr id="row609810457093525"><th class="cellrowborder" valign="top" width="50%" id="mcps1.1.3.1.1"><p id="p1228505214093525"><a name="p1228505214093525"></a><a name="p1228505214093525"></a>Enumeration Name</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.1.3.1.2"><p id="p1645970392093525"><a name="p1645970392093525"></a><a name="p1645970392093525"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row1507224824093525"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.1 "><p id="p639916108093525"><a name="p639916108093525"></a><a name="p639916108093525"></a><a href="I2C.md#ga32b58f021632085445d80c80e382a546">I2cFlag</a> { &nbsp;&nbsp;<a href="I2C.md#gga32b58f021632085445d80c80e382a546a65c5829d919f53dbc00b4c4e3f5a2f7a">I2C_FLAG_READ</a> = (0x1 &lt;&lt; 0), <a href="I2C.md#gga32b58f021632085445d80c80e382a546a830aec226b260e4624fb81f355e4fbd6">I2C_FLAG_ADDR_10BIT</a> = (0x1 &lt;&lt; 4), <a href="I2C.md#gga32b58f021632085445d80c80e382a546a801a2ec0dcf3069ba412311d00e45356">I2C_FLAG_READ_NO_ACK</a> = (0x1 &lt;&lt; 11), <a href="I2C.md#gga32b58f021632085445d80c80e382a546a6c8d6f7ba01b0e45fb73ee5883ba311c">I2C_FLAG_IGNORE_NO_ACK</a> = (0x1 &lt;&lt; 12), &nbsp;&nbsp;<a href="I2C.md#gga32b58f021632085445d80c80e382a546a87b7c3b732260789c5acd9245171ad25">I2C_FLAG_NO_START</a> = (0x1 &lt;&lt; 14), <a href="I2C.md#gga32b58f021632085445d80c80e382a546a641c29990d13fe5f840b495dca8e21e9">I2C_FLAG_STOP</a> = (0x1 &lt;&lt; 15) }</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.2 "><p id="p821424072093525"><a name="p821424072093525"></a><a name="p821424072093525"></a>Enumerates flags used for transferring I2C messages. </p>
</td>
</tr>
</tbody>
</table>

## Functions<a name="func-members"></a>

<a name="table1745353040093525"></a>
<table><thead align="left"><tr id="row1660433423093525"><th class="cellrowborder" valign="top" width="50%" id="mcps1.1.3.1.1"><p id="p808506890093525"><a name="p808506890093525"></a><a name="p808506890093525"></a>Function Name</p>
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.1.3.1.2"><p id="p1645299341093525"><a name="p1645299341093525"></a><a name="p1645299341093525"></a>Description</p>
</th>
</tr>
</thead>
<tbody><tr id="row802887134093525"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.1 "><p id="p691901043093525"><a name="p691901043093525"></a><a name="p691901043093525"></a><a href="I2C.md#ga7551f766dcabd70e96dbfe5e6585c6fb">I2cOpen</a> (int16_t number)</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.2 "><p id="p1375705581093525"><a name="p1375705581093525"></a><a name="p1375705581093525"></a>struct <a href="DevHandle.md">DevHandle</a> *&nbsp;</p>
<p id="p1022451773093525"><a name="p1022451773093525"></a><a name="p1022451773093525"></a>Obtains the handle of an I2C controller. </p>
</td>
</tr>
<tr id="row590097537093525"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.1 "><p id="p439170874093525"><a name="p439170874093525"></a><a name="p439170874093525"></a><a href="I2C.md#ga3dbd2556b29861859b360693f355df1f">I2cClose</a> (struct <a href="DevHandle.md">DevHandle</a> *handle)</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.2 "><p id="p1266240643093525"><a name="p1266240643093525"></a><a name="p1266240643093525"></a>void&nbsp;</p>
<p id="p1992705447093525"><a name="p1992705447093525"></a><a name="p1992705447093525"></a>Releases the handle of an I2C controller. </p>
</td>
</tr>
<tr id="row853562770093525"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.1 "><p id="p170051827093525"><a name="p170051827093525"></a><a name="p170051827093525"></a><a href="I2C.md#ga2fbc639bd3c5f9e5e9657c64d88bcbc9">I2cTransfer</a> (struct <a href="DevHandle.md">DevHandle</a> *handle, struct <a href="I2cMsg.md">I2cMsg</a> *msgs, int16_t count)</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.1.3.1.2 "><p id="p1215025722093525"><a name="p1215025722093525"></a><a name="p1215025722093525"></a>int32_t&nbsp;</p>
<p id="p185292374093525"><a name="p185292374093525"></a><a name="p185292374093525"></a>Launches a custom transfer to an I2C device. </p>
</td>
</tr>
</tbody>
</table>

一键复制编辑原始数据按行查看历史

提交于 2020-09-08 10:08 . add OpenHarmony 1.0 baseline

i2c_if.h

Overview

Related Modules:

I2C

Description:

Declares the standard I2C interface functions.

Since:

1.0

Summary

Data Structures

Data Structure Name	Description
I2cMsg	Defines the I2C transfer message used during custom transfers.

Enumerations

Enumeration Name	Description
I2cFlag { I2C_FLAG_READ = (0x1 << 0), I2C_FLAG_ADDR_10BIT = (0x1 << 4), I2C_FLAG_READ_NO_ACK = (0x1 << 11), I2C_FLAG_IGNORE_NO_ACK = (0x1 << 12), I2C_FLAG_NO_START = (0x1 << 14), I2C_FLAG_STOP = (0x1 << 15) }	Enumerates flags used for transferring I2C messages.

Functions

Function Name	Description
I2cOpen (int16_t number)	struct DevHandle * Obtains the handle of an I2C controller.
I2cClose (struct DevHandle *handle)	void Releases the handle of an I2C controller.
I2cTransfer (struct DevHandle handle, struct I2cMsg msgs, int16_t count)	int32_t Launches a custom transfer to an I2C device.

Function Name

Description

I2cOpen (int16_t number)

struct DevHandle *

Obtains the handle of an I2C controller.

I2cClose (struct DevHandle *handle)

void

Releases the handle of an I2C controller.

I2cTransfer (struct DevHandle *handle, struct I2cMsg *msgs, int16_t count)

int32_t

Launches a custom transfer to an I2C device.

https://gitee.com/taoguan/docs.git

git@gitee.com:taoguan/docs.git

taoguan

docs

master

taoguan / docs

i2c_if.h

Overview

Summary

Data Structures

Enumerations

Functions

简介

发行版

贡献者

近期动态

taoguan / docs .gitee-modal { width: 500px !important; }

i2c_if.h

Overview

Summary

Data Structures

Enumerations

Functions

简介

发行版

贡献者

近期动态

搜索帮助

taoguan / docs