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

244 lines
23 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 层接口设计 以下接口是 Watchdog 设备驱动框架的标准接口。 struct rt_watchdog_ops { rt_err_t (*init)(rt_watchdog_t *wdt); rt_err_t (*control)(rt_watchdog_t *wdt, int cmd, void *arg); }; 表 1 . drv_wdt_init 函数原型 rt_err_t ..."/><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.contributor" content="yan.wang"/><meta name="DC.date.modified" content="2024-11-26"/><meta name="DC.format" content="HTML5"/><meta name="DC.identifier" content="watchdog_interface_design_luban_lite"/><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/watchdog/watchdog-interface-design-luban-lite.dita"/><meta name="wh-out-relpath" content="topics/sdk/watchdog/watchdog-interface-design-luban-lite.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="watchdog_interface_design_luban_lite" 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/watchdog/watchdog-interface-design-luban-lite.dita">Edit online</a></span><h1 class="- topic/title title topictitle1" id="ariaid-title1">接口设计</h1><div class="date inPage">26 Nov 2024</div><div style="color: gray;">
Read time: 3 minute(s)
</div><div class="- topic/body concept/conbody body conbody"><section class="- topic/section section" id="watchdog_interface_design_luban_lite__driver" data-ofbid="watchdog_interface_design_luban_lite__driver"><h2 class="- topic/title title sectiontitle">Driver 层接口设计</h2>
<div class="- topic/p p" data-ofbid="d144041e27__20250121171609">以下接口是 Watchdog
设备驱动框架的标准接口。<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="watchdog_interface_design_luban_lite__codeblock_ybb_sch_ddc" data-ofbid="watchdog_interface_design_luban_lite__codeblock_ybb_sch_ddc"><strong class="hl-keyword">struct</strong> rt_watchdog_ops
{
rt_err_t (*init)(rt_watchdog_t *wdt);
rt_err_t (*control)(rt_watchdog_t *wdt, <strong class="hl-keyword">int</strong> cmd, <strong class="hl-keyword">void</strong> *arg);
};</pre></div>
<div class="table-container"><table class="- topic/table table frame-all" id="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc" data-ofbid="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc" 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_wdt_init</span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><thead class="- topic/thead thead"><tr class="- topic/row"><th class="- topic/entry entry colsep-1 rowsep-1" id="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__1">函数原型</th><th class="- topic/entry entry colsep-0 rowsep-1" id="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__2">rt_err_t drv_wdt_init(rt_watchdog_t *wdt)</th></tr></thead><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__1">功能说明</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__2">Watchdog 控制器的初始化</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__1">参数定义</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__2"></td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__1">返回值</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__2">0成功&lt;0失败</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0" headers="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__1">注意事项</td><td class="- topic/entry entry colsep-0 rowsep-0" headers="watchdog_interface_design_luban_lite__table_hl1_kxh_bdc__entry__2">-</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table frame-all" id="watchdog_interface_design_luban_lite__table_il1_kxh_bdc" data-ofbid="watchdog_interface_design_luban_lite__table_il1_kxh_bdc" 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_wdt_control</span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><thead class="- topic/thead thead"><tr class="- topic/row"><th class="- topic/entry entry colsep-1 rowsep-1" id="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__1">函数原型</th><th class="- topic/entry entry colsep-0 rowsep-1" id="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__2">rt_err_t drv_wdt_control(rt_watchdog_t *wdt, int cmd, void
*args)</th></tr></thead><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__1">功能说明</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__2">Watchdog 驱动的 ioctl 接口</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__1">参数定义</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__2">
<div class="- topic/div div">
<div class="- topic/div div">wdt - 指向 Watchdog 设备</div>
<div class="- topic/div div">cmd - ioctl 命令码</div>
<div class="- topic/div div">args - ioctl 命令相应的参数</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1" headers="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__1">返回值</td><td class="- topic/entry entry colsep-0 rowsep-1" headers="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__2">0成功&lt;0失败</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0" headers="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__1">注意事项</td><td class="- topic/entry entry colsep-0 rowsep-0" headers="watchdog_interface_design_luban_lite__table_il1_kxh_bdc__entry__2">-</td></tr></tbody></table></div>
<div class="- topic/sectiondiv sectiondiv">
<p class="- topic/p p" data-ofbid="d144041e121__20250121171609">CMD 命令码可以用于控制 Watchdog 的行为例如设置超时时间、获取剩余时间、刷新看门狗等。CMD 命令码详细定义描述如下:</p>
<ul class="- topic/ul ul" id="watchdog_interface_design_luban_lite__ul_amx_bfh_ddc" data-ofbid="watchdog_interface_design_luban_lite__ul_amx_bfh_ddc"><li class="- topic/li li" data-ofbid="d144041e125__20250121171609">标准命令码:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="watchdog_interface_design_luban_lite__codeblock_qgx_tch_ddc" data-ofbid="watchdog_interface_design_luban_lite__codeblock_qgx_tch_ddc">#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_GET_TIMEOUT (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">1</span>) <em class="hl-comment">/* get timeout(in seconds) */</em>
#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_SET_TIMEOUT (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">2</span>) <em class="hl-comment">/* set timeout(in seconds) */</em>
#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_GET_TIMELEFT (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">3</span>) <em class="hl-comment">/* get the left time before reboot(in seconds) */</em>
#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_KEEPALIVE (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">4</span>) <em class="hl-comment">/* refresh watchdog */</em>
#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_START (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">5</span>) <em class="hl-comment">/* start watchdog */</em>
#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_STOP (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">6</span>) <em class="hl-comment">/* stop watchdog */</em></pre><p class="- topic/p p" data-ofbid="d144041e129__20250121171609">详见
<span class="+ topic/ph sw-d/filepath ph filepath">rt-thread/components/drivers/include/watchdog.h</span></p></li><li class="- topic/li li" data-ofbid="d144041e134__20250121171609">AIC
特定的命令码<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="watchdog_interface_design_luban_lite__codeblock_z5h_5ch_ddc" data-ofbid="watchdog_interface_design_luban_lite__codeblock_z5h_5ch_ddc">#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_SET_IRQ_TIMEOUT (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">7</span>) <em class="hl-comment">/* set pretimeout(in seconds) */</em>
#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_IRQ_ENABLE (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">8</span>) <em class="hl-comment">/* start pretreatment */</em>
#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_IRQ_DISABLE (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">9</span>) <em class="hl-comment">/* stop pretreatment */</em>
#<span class="hl-directive">define</span> RT_DEVICE_CTRL_WDT_SET_CLR_THD (RT_DEVICE_CTRL_BASE(WDT) + <span class="hl-number">10</span>) <em class="hl-comment">/* set clear threshold */</em></pre><p class="- topic/p p" data-ofbid="d144041e138__20250121171609">详见
<span class="+ topic/ph sw-d/filepath ph filepath">bsp/arcinchip/include/drv/aic_drv_wdt.h</span></p></li></ul>
</div>
</section><section class="- topic/section section" id="watchdog_interface_design_luban_lite__section_nlc_dtg_f1c" data-ofbid="watchdog_interface_design_luban_lite__section_nlc_dtg_f1c"><h2 class="- topic/title title sectiontitle">HAL 层接口设计</h2>
<div class="- topic/p p" data-ofbid="d144041e150__20250121171609">HAL 层的函数接口声明存放在 hal_wdt.h
中,主要接口有:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="watchdog_interface_design_luban_lite__codeblock_lrp_dtg_f1c" data-ofbid="watchdog_interface_design_luban_lite__codeblock_lrp_dtg_f1c"><strong class="hl-keyword">void</strong> hal_wdt_op_clr(u32 thd);
s32 hal_wdt_is_running(<strong class="hl-keyword">void</strong>);
<strong class="hl-keyword">void</strong> hal_wdt_clr_thd_set(u32 ch, <strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">void</strong> hal_wdt_irq_thd_set(u32 ch, <strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">void</strong> hal_wdt_rst_thd_set(u32 ch, <strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">void</strong> hal_wdt_switch_chan(<strong class="hl-keyword">int</strong> chan);
u32 hal_wdt_remain(<strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">void</strong> hal_wdt_enable(u32 enable, u32 dbg_continue);
<strong class="hl-keyword">void</strong> hal_wdt_irq_enable(u32 enable);
<strong class="hl-keyword">int</strong> hal_wdt_irq_sta(<strong class="hl-keyword">void</strong>);
<strong class="hl-keyword">void</strong> hal_wdt_thd_get(u32 ch, <strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">int</strong> hal_wdt_clr_int(<strong class="hl-keyword">void</strong>);
<strong class="hl-keyword">void</strong> hal_wdt_status_show(u32 ch);</pre></div>
</section><section class="- topic/section section" id="watchdog_interface_design_luban_lite__hal" data-ofbid="watchdog_interface_design_luban_lite__hal"><h2 class="- topic/title title sectiontitle">HAL 层接口设计</h2>
<div class="- topic/p p" data-ofbid="d144041e160__20250121171609">HAL 层的函数接口声明存放在 <span class="+ topic/ph sw-d/filepath ph filepath">hal_wdt.h</span>
中,主要接口有:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="watchdog_interface_design_luban_lite__codeblock_d5d_v2h_ddc" data-ofbid="watchdog_interface_design_luban_lite__codeblock_d5d_v2h_ddc"><strong class="hl-keyword">void</strong> hal_wdt_op_clr(u32 thd);
s32 hal_wdt_is_running(<strong class="hl-keyword">void</strong>);
<strong class="hl-keyword">void</strong> hal_wdt_clr_thd_set(u32 ch, <strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">void</strong> hal_wdt_irq_thd_set(u32 ch, <strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">void</strong> hal_wdt_rst_thd_set(u32 ch, <strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">void</strong> hal_wdt_switch_chan(<strong class="hl-keyword">int</strong> chan);
u32 hal_wdt_remain(<strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">void</strong> hal_wdt_enable(u32 enable, u32 dbg_continue);
<strong class="hl-keyword">void</strong> hal_wdt_irq_enable(u32 enable);
<strong class="hl-keyword">int</strong> hal_wdt_irq_sta(<strong class="hl-keyword">void</strong>);
<strong class="hl-keyword">void</strong> hal_wdt_thd_get(u32 ch, <strong class="hl-keyword">struct</strong> aic_wdt *wdt);
<strong class="hl-keyword">int</strong> hal_wdt_clr_int(<strong class="hl-keyword">void</strong>);
<strong class="hl-keyword">void</strong> hal_wdt_status_show(u32 ch);</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="#watchdog_interface_design_luban_lite__driver" data-tocid="watchdog_interface_design_luban_lite__driver">Driver 层接口设计</a></div></li><li class="section-item"><div class="section-title"><a href="#watchdog_interface_design_luban_lite__section_nlc_dtg_f1c" data-tocid="watchdog_interface_design_luban_lite__section_nlc_dtg_f1c">HAL 层接口设计</a></div></li><li class="section-item"><div class="section-title"><a href="#watchdog_interface_design_luban_lite__hal" data-tocid="watchdog_interface_design_luban_lite__hal">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>