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

210 lines
20 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="Driver 层接口设计 以下接口是 GPAI 设备驱动框架的标准接口。 struct rt_adc_ops { rt_err_t (*enabled)( struct rt_adc_device *device, rt_uint32_t channel, rt_bool_t enabled); rt_err_t (*convert)( struct rt_adc_device *device, ..."/><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-29"/><meta name="DC.date.modified" content="2024-07-05"/><meta name="DC.format" content="HTML5"/><meta name="DC.identifier" content="gpai_interface_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/gpai/gpai_interface.dita"/><meta name="wh-out-relpath" content="topics/sdk/gpai/gpai_interface.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="gpai_interface_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-lg-10 col-md-10 col-sm-10 col-xs-12" id="wh_topic_body">
<button id="wh_close_topic_toc_button" class="close-toc-button d-none" aria-label="Toggle topic table of content" aria-controls="wh_topic_toc" aria-expanded="true">
<span class="close-toc-icon-container">
<span class="close-toc-icon"></span>
</span>
</button>
<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/gpai/gpai_interface.dita">Edit online</a></span><h1 class="- topic/title title topictitle1" id="ariaid-title1">接口设计</h1><div class="date inPage">5 Jul 2024</div><div style="color: gray;">
Read time: 1 minute(s)
</div><div class="- topic/body concept/conbody body conbody"><section class="- topic/section section" id="gpai_interface_design__section_hw3_nyk_g1c" data-ofbid="gpai_interface_design__section_hw3_nyk_g1c"><h2 class="- topic/title title sectiontitle">Driver 层接口设计</h2>
<div class="- topic/p p" data-ofbid="d244910e28__20250121171700">以下接口是 GPAI 设备驱动框架的标准接口。<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="gpai_interface_design__codeblock_fxn_ryk_g1c" data-ofbid="gpai_interface_design__codeblock_fxn_ryk_g1c"><strong class="hl-keyword">struct</strong> rt_adc_ops
{
rt_err_t (*enabled)(<strong class="hl-keyword">struct</strong> rt_adc_device *device, rt_uint32_t channel, rt_bool_t enabled);
rt_err_t (*convert)(<strong class="hl-keyword">struct</strong> rt_adc_device *device, rt_uint32_t channel, rt_uint32_t *value);
rt_uint8_t (*get_resolution)(<strong class="hl-keyword">struct</strong> rt_adc_device *device);
rt_int16_t (*get_vref) (<strong class="hl-keyword">struct</strong> rt_adc_device *device);
};</pre></div>
<p class="- topic/p p" data-ofbid="d244910e33__20250121171700">其中的 get_vref() 暂未支持。</p>
<div class="table-container"><table class="- topic/table table frame-all" id="gpai_interface_design__table_jw3_nyk_g1c" data-ofbid="gpai_interface_design__table_jw3_nyk_g1c" data-cols="2"><caption class="- topic/title title tablecap" data-caption-side="top" data-is-repeated="true"><span class="table--title-label"><span class="table--title-label-number"> 1</span><span class="table--title-label-punctuation">. </span></span><span class="table--title">drv_gpai_enabled</span></caption><colgroup><col style="width:25%"/><col style="width:75%"/></colgroup><thead class="- topic/thead thead"><tr class="- topic/row"><th class="- topic/entry entry colsep-1 rowsep-1" id="gpai_interface_design__table_jw3_nyk_g1c__entry__1">函数原型</th><th class="- topic/entry entry colsep-0 rowsep-1" id="gpai_interface_design__table_jw3_nyk_g1c__entry__2">rt_err_t drv_gpai_enabled(struct rt_adc_device *dev, rt_uint32_t
ch, rt_bool_t enabled)</th></tr></thead><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="gpai_interface_design__table_jw3_nyk_g1c__entry__1">功能说明</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="gpai_interface_design__table_jw3_nyk_g1c__entry__2">使能一个 ADC 通道</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="gpai_interface_design__table_jw3_nyk_g1c__entry__1">参数定义</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="gpai_interface_design__table_jw3_nyk_g1c__entry__2">
<ul class="- topic/ul ul" id="gpai_interface_design__ul_wjr_ql4_ybc" data-ofbid="gpai_interface_design__ul_wjr_ql4_ybc"><li class="- topic/li li" data-ofbid="d244910e60__20250121171700">dev - 指向 ADC 设备 </li><li class="- topic/li li" data-ofbid="d244910e62__20250121171700">ch - 指定 ADC 通道的通道编号 </li><li class="- topic/li li" data-ofbid="d244910e64__20250121171700">enable - 使能</li></ul>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="gpai_interface_design__table_jw3_nyk_g1c__entry__1">返回值</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="gpai_interface_design__table_jw3_nyk_g1c__entry__2">0成功。 &lt; 0失败</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0" headers="gpai_interface_design__table_jw3_nyk_g1c__entry__1">注意事项</td><td class="- topic/entry entry colsep-0 rowsep-0" headers="gpai_interface_design__table_jw3_nyk_g1c__entry__2">-</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table frame-all" id="gpai_interface_design__table_kw3_nyk_g1c" data-ofbid="gpai_interface_design__table_kw3_nyk_g1c" data-cols="2"><caption class="- topic/title title tablecap" data-caption-side="top" data-is-repeated="true"><span class="table--title-label"><span class="table--title-label-number"> 2</span><span class="table--title-label-punctuation">. </span></span><span class="table--title">drv_gpai_convert</span></caption><colgroup><col style="width:25%"/><col style="width:75%"/></colgroup><thead class="- topic/thead thead"><tr class="- topic/row"><th class="- topic/entry entry colsep-1 rowsep-1" id="gpai_interface_design__table_kw3_nyk_g1c__entry__1">函数原型</th><th class="- topic/entry entry colsep-0 rowsep-1" id="gpai_interface_design__table_kw3_nyk_g1c__entry__2">rt_err_t drv_gpai_convert(struct rt_adc_device *dev, rt_uint32_t
ch, rt_uint32_t *value)</th></tr></thead><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="gpai_interface_design__table_kw3_nyk_g1c__entry__1">功能说明</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="gpai_interface_design__table_kw3_nyk_g1c__entry__2">读取一个 ADC 通道的当前数据</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="gpai_interface_design__table_kw3_nyk_g1c__entry__1">参数定义</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="gpai_interface_design__table_kw3_nyk_g1c__entry__2">
<ul class="- topic/ul ul" id="gpai_interface_design__ul_glx_rl4_ybc" data-ofbid="gpai_interface_design__ul_glx_rl4_ybc"><li class="- topic/li li" data-ofbid="d244910e102__20250121171700">dev - 指向 ADC 设备 </li><li class="- topic/li li" data-ofbid="d244910e104__20250121171700">ch - 指定 ADC 通道的通道编号 </li><li class="- topic/li li" data-ofbid="d244910e106__20250121171700">value - 用于保存返回的 ADC 数据</li></ul>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="gpai_interface_design__table_kw3_nyk_g1c__entry__1">返回值</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="gpai_interface_design__table_kw3_nyk_g1c__entry__2">0成功。 &lt; 0失败</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0" headers="gpai_interface_design__table_kw3_nyk_g1c__entry__1">注意事项</td><td class="- topic/entry entry colsep-0 rowsep-0" headers="gpai_interface_design__table_kw3_nyk_g1c__entry__2">-</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table frame-all" id="gpai_interface_design__table_lw3_nyk_g1c" data-ofbid="gpai_interface_design__table_lw3_nyk_g1c" data-cols="2"><caption class="- topic/title title tablecap" data-caption-side="top" data-is-repeated="true"><span class="table--title-label"><span class="table--title-label-number"> 3</span><span class="table--title-label-punctuation">. </span></span><span class="table--title">drv_gpai_resolution</span></caption><colgroup><col style="width:25%"/><col style="width:75%"/></colgroup><thead class="- topic/thead thead"><tr class="- topic/row"><th class="- topic/entry entry colsep-1 rowsep-1" id="gpai_interface_design__table_lw3_nyk_g1c__entry__1">函数原型</th><th class="- topic/entry entry colsep-0 rowsep-1" id="gpai_interface_design__table_lw3_nyk_g1c__entry__2">rt_err_t drv_gpai_resolution(struct rt_adc_device *dev)</th></tr></thead><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="gpai_interface_design__table_lw3_nyk_g1c__entry__1">功能说明</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="gpai_interface_design__table_lw3_nyk_g1c__entry__2">获取 GPAI 控制器的采样精度</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="gpai_interface_design__table_lw3_nyk_g1c__entry__1">参数定义</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="gpai_interface_design__table_lw3_nyk_g1c__entry__2">dev - 指向 ADC 设备</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="gpai_interface_design__table_lw3_nyk_g1c__entry__1">返回值</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="gpai_interface_design__table_lw3_nyk_g1c__entry__2">12表示 12bit 的采样精度</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0" headers="gpai_interface_design__table_lw3_nyk_g1c__entry__1">注意事项</td><td class="- topic/entry entry colsep-0 rowsep-0" headers="gpai_interface_design__table_lw3_nyk_g1c__entry__2">-</td></tr></tbody></table></div>
</section><section class="- topic/section section" id="gpai_interface_design__section_mw3_nyk_g1c" data-ofbid="gpai_interface_design__section_mw3_nyk_g1c"><h2 class="- topic/title title sectiontitle">HAL 层接口设计</h2>
<div class="- topic/p p" data-ofbid="d244910e160__20250121171700">HAL 层的函数接口声明存放在 hal_gpai.h
中,主要接口有:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="gpai_interface_design__codeblock_qxy_nyk_g1c" data-ofbid="gpai_interface_design__codeblock_qxy_nyk_g1c"><strong class="hl-keyword">void</strong> aich_gpai_enable(<strong class="hl-keyword">int</strong> enable);
<strong class="hl-keyword">void</strong> aich_gpai_ch_enable(u32 ch, <strong class="hl-keyword">int</strong> enable);
<strong class="hl-keyword">int</strong> aich_gpai_ch_init(<strong class="hl-keyword">struct</strong> aic_gpai_ch *chan, u32 pclk);
irqreturn_t aich_gpai_isr(<strong class="hl-keyword">int</strong> irq, <strong class="hl-keyword">void</strong> *arg);
<strong class="hl-keyword">int</strong> aich_gpai_read(<strong class="hl-keyword">struct</strong> aic_gpai_ch *chan, u32 *val, u32 timeout);
s32 aich_gpai_data2vol(u16 data);
<strong class="hl-keyword">struct</strong> aic_gpai_ch *hal_gpai_ch_is_valid(u32 ch);
<strong class="hl-keyword">void</strong> hal_gpai_set_ch_num(u32 num);
<strong class="hl-keyword">void</strong> aich_gpai_status_show(<strong class="hl-keyword">struct</strong> aic_gpai_ch *chan);</pre></div>
</section></div></article></main></div>
</div>
<nav role="navigation" id="wh_topic_toc" aria-label="On this page" class="col-lg-2 d-none d-lg-block navbar d-print-none">
<div id="wh_topic_toc_content">
<div class=" wh_topic_toc "><div class="wh_topic_label">在本页上</div><ul><li class="section-item"><div class="section-title"><a href="#gpai_interface_design__section_hw3_nyk_g1c" data-tocid="gpai_interface_design__section_hw3_nyk_g1c">Driver 层接口设计</a></div></li><li class="section-item"><div class="section-title"><a href="#gpai_interface_design__section_mw3_nyk_g1c" data-tocid="gpai_interface_design__section_mw3_nyk_g1c">HAL 层接口设计</a></div></li></ul></div>
</div>
</nav>
</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>