Files
luban-lite-t3e-pro/doc/topics/sdk/i2c/i2c_data_struct.html
2025-01-23 16:37:00 +08:00

219 lines
14 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh-cn" lang="zh-cn" data-whc_version="26.0">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="description" content="drv 层管理 I2C 控制器资源的顶层结构体 struct aic_i2c_bus { struct rt_i2c_bus_device bus; //RTT 内核 I2C 控制器数据结构 aic_i2c_ctrl aic_bus; //I2C 控制器资源的底层结构体 struct rt_completion cmd_complete; //完成量,用于指示一个 message 是否传输完成 ..."/><meta name="DC.rights.owner" content="(C) 版权 2025"/><meta name="copyright" content="(C) 版权 2025"/><meta name="generator" content="DITA-OT"/><meta name="DC.type" content="concept"/><meta name="DC.creator" content="yan.wang"/><meta name="DC.date.created" content="2024-01-23"/><meta name="DC.date.modified" content="2024-12-02"/><meta name="DC.format" content="HTML5"/><meta name="DC.identifier" content="i2c_data_structure_design"/><meta name="DC.language" content="zh-CN"/><title>数据结构设计</title><!-- Build number 2023110923. --><meta name="wh-path2root" content="../../../"/><meta name="wh-toc-id" content=""/><meta name="wh-source-relpath" content="topics/sdk/i2c/i2c_data_struct.dita"/><meta name="wh-out-relpath" content="topics/sdk/i2c/i2c_data_struct.html"/>
<link rel="stylesheet" type="text/css" href="../../../webhelp/app/commons.css?buildId=2023110923"/>
<link rel="stylesheet" type="text/css" href="../../../webhelp/app/topic.css?buildId=2023110923"/>
<script src="../../../webhelp/app/options/properties.js?buildId=20250121171154"></script>
<script src="../../../webhelp/app/localization/strings.js?buildId=2023110923"></script>
<script src="../../../webhelp/app/search/index/keywords.js?buildId=20250121171154"></script>
<script defer="defer" src="../../../webhelp/app/commons.js?buildId=2023110923"></script>
<script defer="defer" src="../../../webhelp/app/topic.js?buildId=2023110923"></script>
<link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-styles-web.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/notes.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-common.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-images.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/footnote.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-web-watermark.css?buildId=2023110923"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/topic-body-list.css?buildId=2023110923"/></head>
<body id="i2c_data_structure_design" class="wh_topic_page frmBody">
<a href="#wh_topic_body" class="sr-only sr-only-focusable">
跳转到主要内容
</a>
<header class="navbar navbar-default wh_header">
<div class="container-fluid">
<div class="wh_header_flex_container navbar-nav navbar-expand-md navbar-dark">
<div class="wh_logo_and_publication_title_container">
<div class="wh_logo_and_publication_title">
<a href="http://www.artinchip.com" class=" wh_logo d-none d-sm-block "><img src="../../../company-logo-white.png" alt="RTOS SDK 使用指南SDK 指南文件"/></a>
<div class=" wh_publication_title "><a href="../../../index.html"><span class="booktitle"><span class="ph mainbooktitle">RTOS SDK 使用指南</span><span class="ph booktitlealt">SDK 指南文件</span></span></a></div>
</div>
</div>
<div class="wh_top_menu_and_indexterms_link collapse navbar-collapse" id="wh_top_menu_and_indexterms_link">
</div>
</div>
</div>
</header>
<div class=" wh_search_input navbar-form wh_topic_page_search search " role="form">
<form id="searchForm" method="get" role="search" action="../../../search.html"><div><input type="search" placeholder="搜索 " class="wh_search_textfield" id="textToSearch" name="searchQuery" aria-label="搜索查询" required="required"/><button type="submit" class="wh_search_button" aria-label="搜索"><span class="search_input_text">搜索</span></button></div></form>
</div>
<div class="container-fluid" id="wh_topic_container">
<div class="row">
<nav class="wh_tools d-print-none navbar-expand-md" aria-label="Tools">
<div data-tooltip-position="bottom" class=" wh_breadcrumb "></div>
<div class="wh_right_tools">
<button class="wh_hide_highlight" aria-label="切换搜索突出显示" title="切换搜索突出显示"></button>
<button class="webhelp_expand_collapse_sections" data-next-state="collapsed" aria-label="折叠截面" title="折叠截面"></button>
<div class=" wh_print_link print d-none d-md-inline-block "><button onClick="window.print()" title="打印此页" aria-label="打印此页"></button></div>
</div>
</nav>
</div>
<div class="wh_content_area">
<div class="row">
<div class="col-12" id="wh_topic_body">
<div class=" wh_topic_content body "><main role="main"><article class="- topic/topic concept/concept topic concept" role="article" aria-labelledby="ariaid-title1"><span class="edit-link" style="font-size:12px; opacity:0.6; text-align:right; vertical-align:middle"><a target="_blank" href="http://172.16.35.88/tasks/jdssno1uvvbf2mltu9kb9v3if05d5gopuakboe8hlud18rma/edit/F:/aicdita/aicdita-cn/topics/sdk/i2c/i2c_data_struct.dita">Edit online</a></span><h1 class="- topic/title title topictitle1" id="ariaid-title1">数据结构设计</h1><div class="date inPage">2 Dec 2024</div><div style="color: gray;">
Read time: 2 minute(s)
</div><div class="- topic/body concept/conbody body conbody"><ul class="- topic/ul ul" id="i2c_data_structure_design__ul_zzr_3hz_gdc" data-ofbid="i2c_data_structure_design__ul_zzr_3hz_gdc"><li class="- topic/li li" data-ofbid="d162638e24__20250121171617">
<div class="- topic/p p" data-ofbid="d162638e26__20250121171617">drv 层管理 I2C
控制器资源的顶层结构体<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="i2c_data_structure_design__codeblock_d5r_gg3_fdc" data-ofbid="i2c_data_structure_design__codeblock_d5r_gg3_fdc"><strong class="hl-keyword">struct</strong> aic_i2c_bus {
<strong class="hl-keyword">struct</strong> rt_i2c_bus_device bus; <em class="hl-comment">//RTT 内核 I2C 控制器数据结构</em>
aic_i2c_ctrl aic_bus; <em class="hl-comment">//I2C 控制器资源的底层结构体</em>
<strong class="hl-keyword">struct</strong> rt_completion cmd_complete; <em class="hl-comment">//完成量,用于指示一个 message 是否传输完成</em>
};</pre></div>
</li><li class="- topic/li li" data-ofbid="d162638e31__20250121171617">
<div class="- topic/p p" data-ofbid="d162638e33__20250121171617">RTT 内核 I2C
控制器数据结构<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="i2c_data_structure_design__codeblock_bs5_gg3_fdc" data-ofbid="i2c_data_structure_design__codeblock_bs5_gg3_fdc"><strong class="hl-keyword">struct</strong> rt_i2c_bus_device
{
<strong class="hl-keyword">struct</strong> rt_device parent; <em class="hl-comment">//设备基类 device</em>
<strong class="hl-keyword">const</strong> <strong class="hl-keyword">struct</strong> rt_i2c_bus_device_ops *ops; <em class="hl-comment">//I2C 操作方法</em>
rt_uint16_t flags; <em class="hl-comment">//I2C 读写标志</em>
<strong class="hl-keyword">struct</strong> rt_mutex lock; <em class="hl-comment">//互斥锁,保证多线程访问安全</em>
rt_uint32_t timeout; <em class="hl-comment">//超时时间</em>
rt_uint32_t retries; <em class="hl-comment">//调用次数</em>
<strong class="hl-keyword">void</strong> *priv; <em class="hl-comment">//私有数据</em>
};</pre></div>
</li><li class="- topic/li li" data-ofbid="d162638e38__20250121171617">
<div class="- topic/p p" data-ofbid="d162638e40__20250121171617">hal 层管理 I2C
控制器资源的底层结构体<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="i2c_data_structure_design__codeblock_scw_gg3_fdc" data-ofbid="i2c_data_structure_design__codeblock_scw_gg3_fdc"><strong class="hl-keyword">struct</strong> aic_i2c_ctrl
{
int32_t index;
<strong class="hl-keyword">char</strong> *device_name;
<strong class="hl-keyword">unsigned</strong> <strong class="hl-keyword">long</strong> reg_base;
uint32_t addr_bit;
uint32_t speed_mode;
uint32_t bus_mode;
<strong class="hl-keyword">struct</strong> aic_i2c_msg *msg; <em class="hl-comment">//指向当前传输的 message</em>
<strong class="hl-keyword">struct</strong> aic_i2c_slave_info slave; <em class="hl-comment">//从机信息数据结构</em>
<strong class="hl-keyword">enum</strong> aic_msg_status msg_status;
uint32_t slave_addr;
uint32_t abort_source;
uint32_t msg_err;
uint32_t buf_write_idx; <em class="hl-comment">//当前 message 为 write msg 时buf_write_idx 为写数据的计数。当前 message 为 read msg 时buf_write_idx 为写命令的计数(I2C 模块需要每次写 read 命令,才能读出数据)。</em>
uint32_t buf_read_idx; <em class="hl-comment">//读数据的计数</em>
bool is_first_message; <em class="hl-comment">//是否是最后一个 message</em>
bool is_last_message; <em class="hl-comment">//是否是第一个 message</em>
};</pre></div>
</li><li class="- topic/li li" data-ofbid="d162638e45__20250121171617">
<div class="- topic/p p" data-ofbid="d162638e47__20250121171617">I2C
消息数据结构原型<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="i2c_data_structure_design__codeblock_avx_gg3_fdc" data-ofbid="i2c_data_structure_design__codeblock_avx_gg3_fdc"><strong class="hl-keyword">struct</strong> aic_i2c_msg
{
uint16_t addr; <em class="hl-comment">// 从机地址</em>
uint16_t flags; <em class="hl-comment">// 读写标志</em>
uint16_t len; <em class="hl-comment">// 数据长度</em>
uint8_t *buf; <em class="hl-comment">// 待传输数据的指针</em>
};</pre></div>
</li><li class="- topic/li li" data-ofbid="d162638e52__20250121171617">
<div class="- topic/p p" data-ofbid="d162638e54__20250121171617">I2C
从机信息数据结构原型<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="i2c_data_structure_design__codeblock_m3z_gg3_fdc" data-ofbid="i2c_data_structure_design__codeblock_m3z_gg3_fdc"><strong class="hl-keyword">struct</strong> aic_i2c_slave_info
{
<strong class="hl-keyword">void</strong> *callback_param; <em class="hl-comment">//回调参数</em>
i2c_slave_cb_t slave_cb; <em class="hl-comment">//从机回调函数</em>
};</pre></div>
</li></ul></div></article></main></div>
</div>
</div>
</div>
</div>
<footer class="navbar navbar-default wh_footer">
<div class=" footer-container mx-auto ">
<title>footer def</title>
<style><!--
.p1 {
font-family: FangZhengShuSong, Times, serif;
}
.p2 {
font-family: Arial, Helvetica, sans-serif;
}
.p3 {
font-family: "Lucida Console", "Courier New", monospace;
}
--></style>
<div class="webhelp.fragment.footer">
<p class="p1">Copyright © 2019-2024 广东匠芯创科技有限公司. All rights reserved.</p>
</div><div>
<div class="generation_time">
Update Time: 2025-01-21
</div>
</div>
</div>
</footer>
<div id="go2top" class="d-print-none">
<span class="oxy-icon oxy-icon-up"></span>
</div>
<div id="modal_img_large" class="modal">
<span class="close oxy-icon oxy-icon-remove"></span>
<div id="modal_img_container"></div>
<div id="caption"></div>
</div>
<script src="${pd}/publishing/publishing-styles-AIC-template/js/custom.js" defer="defer"></script>
</body>
</html>