linuxOS_D21X/doc/topics/sdk/usb/usb-aic_udc_driver.html

245 lines
38 KiB
HTML
Raw Normal View History

2025-01-23 08:35:08 +00:00
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh-cn" lang="zh-cn" data-whc_version="27.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="UDC Driver 在需要完成的工作有两点: 把 UDC 硬件注册成标准的 Gadget Device以便提供标准的 Gadget API 给 Gadget Function 驱动来使用。 提供 endpoint 资源池,处理 endpoint 层级的数据收发。 需要处理部分 Endpoint0 Setup 逻辑。 Init UDC 驱动把资源初始化好以后,注册成一个标准的 gadget ..."/><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.relation" content="../../../topics/sdk/usb/usb-device-controller_layer.html"/><meta name="DC.relation" content="../../../topics/sdk/usb/usb-aic_usb_device_controller.html"/><meta name="DC.relation" content="../../../topics/sdk/usb/usb-device-device_layer.html"/><meta name="DC.contributor" content="yan.wang"/><meta name="DC.contributor" content="yan.wang"/><meta name="DC.date.modified" content="2024-01-15"/><meta name="DC.format" content="HTML5"/><meta name="DC.identifier" content="usb_aic_udc_driver"/><meta name="DC.language" content="zh-CN"/><title>AIC UDC Driver</title><!-- Generated with build number 2024112209. --><meta name="wh-path2root" content="../../../"/><meta name="wh-toc-id" content="usb_aic_udc_driver-d4445e7804"/><meta name="wh-source-relpath" content="topics/sdk/usb/usb-aic_udc_driver.dita"/><meta name="wh-out-relpath" content="topics/sdk/usb/usb-aic_udc_driver.html"/>
<link rel="stylesheet" type="text/css" href="../../../webhelp/app/commons.css?buildId=2024112209"/>
<link rel="stylesheet" type="text/css" href="../../../webhelp/app/topic.css?buildId=2024112209"/>
<script src="../../../webhelp/app/options/properties.js?buildId=20250123154945"></script>
<script src="../../../webhelp/app/localization/strings.js?buildId=2024112209"></script>
<script src="../../../webhelp/app/search/index/keywords.js?buildId=20250123154945"></script>
<script defer="defer" src="../../../webhelp/app/commons.js?buildId=2024112209"></script>
<script defer="defer" src="../../../webhelp/app/topic.js?buildId=2024112209"></script>
<link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-styles-web.css?buildId=2024112209"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/notes.css?buildId=2024112209"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-common.css?buildId=2024112209"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-images.css?buildId=2024112209"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/footnote.css?buildId=2024112209"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/aic-web-watermark.css?buildId=2024112209"/><link rel="stylesheet" type="text/css" href="../../../webhelp/template/topic-body-list.css?buildId=2024112209"/></head>
<body id="usb_aic_udc_driver" 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=" Linux SDK 使用指南 SDK 指南文件 "/></a>
<div class=" wh_publication_title "><a href="../../../index.html"><span class="booktitle"> <span class="ph mainbooktitle">Linux 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 "><ol class="d-print-none"><li><span class="home"><a href="../../../index.html"><span>主页</span></a></span></li><li><div class="topicref" data-id="id"><div class="title"><a href="../../../topics/sdk/chapter-advanced-app.html">高级应用</a><div class="wh-tooltip"><p class="shortdesc">系统、存储、多媒体、接口、安全等模块的详细配置和设计说明。</p></div></div></div></li><li><div class="topicref" data-id="concept_nww_hzh_pzb"><div class="title"><a href="../../../topics/chapter-title/chapter-interface-sdk.html">接口</a><div class="wh-tooltip"><p class="shortdesc">CAN、CIR、GPAI、GPIO、I2C、PSADC、PWM 等接口模块的介绍和使用说明。</p></div></div></div></li><li><div class="topicref" data-id="usb_user_guide"><div class="title"><a href="../../../topics/sdk/usb/usb_user_guide.html">USB 使用指南</a></div></div></li><li><div class="topicref" data-id="usb_device_subsystem_code_structure"><div class="title"><a href="../../../topics/sdk/usb/usb-device_subsystem_code_structure.html">USB Device 子系统代码架构</a></div></div></li><li><div class="topicref" data-id="usb_device_controller_layer"><div class="title"><a href="../../../topics/sdk/usb/usb-device-controller_layer.html">USB Device Controller Layer</a></div></div></li><li class="active"><div class="topicref" data-id="usb_aic_udc_driver"><div class="title"><a href="../../../topics/sdk/usb/usb-aic_udc_driver.html">AIC UDC Driver</a></div></div></li></ol></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_navigation_links "><span id="topic_navigation_links" class="navheader">
<span class="navprev"><a class="- topic/link link" href="../../../topics/sdk/usb/usb-aic_usb_device_controller.html" title="AIC USB Device Controller" aria-label="上一主题: AIC USB Device Controller" rel="prev"></a></span>
<span class="navnext"><a class="- topic/link link" href="../../../topics/sdk/usb/usb-device-device_layer.html" title="USB Device Layer" aria-label="下一主题: USB Device Layer" rel="next"></a></span> </span></div>
<div class=" wh_print_link print d-none d-md-inline-block "><button onClick="window.print()" title="打印此页" aria-label="打印此页"></button></div>
<button type="button" id="wh_toc_button" class="custom-toggler navbar-toggler collapsed wh_toggle_button navbar-light" aria-expanded="false" aria-label="Toggle publishing table of content" aria-controls="wh_publication_toc">
<span class="navbar-toggler-icon"></span>
</button>
</div>
</nav>
</div>
<div class="wh_content_area">
<div class="row">
<nav id="wh_publication_toc" class="col-lg-3 col-md-3 col-sm-12 d-md-block d-none d-print-none" aria-label="Table of Contents Container">
<div id="wh_publication_toc_content">
<div class=" wh_publication_toc " data-tooltip-position="right"><span class="expand-button-action-labels"><span id="button-expand-action" role="button" aria-label="Expand"></span><span id="button-collapse-action" role="button" aria-label="Collapse"></span><span id="button-pending-action" role="button" aria-label="Pending"></span></span><ul role="tree" aria-label="Table of Contents"><li role="treeitem"><div data-tocid="revinfo_linux-d4445e1079" class="topicref" data-id="revinfo_linux" data-state="leaf"><span role="button" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/revinfo/revinfo_linux.html" id="revinfo_linux-d4445e1079-link">修订记录</a></div></div></li><li role="treeitem" aria-expanded="false"><div data-tocid="id-d4445e1096" class="topicref" data-id="id" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action id-d4445e1096-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/env/sdk-compile.html" id="id-d4445e1096-link">SDK 编译</a><div class="wh-tooltip"><p class="shortdesc">介绍不同编译环境下 SDK 的详细编译流程。</p></div></div></div></li><li role="treeitem" aria-expanded="false"><div data-tocid="tocId-d4445e1240" class="topicref" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action tocId-d4445e1240-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/advanced/lb_usage_commands.html" id="tocId-d4445e1240-link">使用指南</a></div></div></li><li role="treeitem" aria-expanded="false"><div data-tocid="concept_rcx_czh_pzb-d4445e1360" class="topicref" data-id="concept_rcx_czh_pzb" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action concept_rcx_czh_pzb-d4445e1360-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/chapter-app.html" id="concept_rcx_czh_pzb-d4445e1360-link">应用场景</a><div class="wh-tooltip"><p class="shortdesc">描述了 SDK 在不同应用场景中的配置和使用包括系统更新、OTA、安全方案等。</p></div></div></div></li><li role="treeitem" aria-expanded="false"><div data-tocid="id-d4445e1678" class="topicref" data-id="id" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action id-d4445e1678-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/peripheral/peripheral-intro.html" id="id-d4445e1678-link">外设移植</a><div class="wh-tooltip"><p class="shortdesc"><span class="ph">触摸屏、显示器、WIFI 模块、按键</span>等外设的介绍和使用说明。</p></div></div></div></li><li role="treeitem" aria-expanded="false"><div data-tocid="id-d4445e1964" class="topicref" data-id="id" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action id-d4445e1964-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/bringup/chapter-bringup.html" id="id-d4445e1964-link">BringUp</a><div class="wh-tooltip"><p class="shortdesc">在硬件上电后快速初始化系统,为操作系统的启动准备好必要的硬件环境。</p></div></div></div></li><li role="treeitem" aria-expanded="true"><div data-tocid="id-d4445e2153" class="topicref" data-id="id" data-state="expanded"><span role="button" tabindex="0" aria-labelledby="button-collapse-action id-d4445e2153-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/chapter-advanced-app.html" id="id-d4445e2153-link">高级应用</a><div class="wh-tooltip"><p class="shortdesc">系统、存储、多媒体、接口、安全等模块的详细配置和设计说明。</p></div></div></div><ul role="group" class="navbar-nav nav-list"><li role="treeitem" aria-expanded="false"><div data-tocid="uBoot-d4445e2170" class="topicref" data-id="uBoot" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action uBoot-d4445e2170-link" class="wh-expand-btn"></span><div class="titl
</div>
</nav>
<div class="col-lg-7 col-md-9 col-sm-12" id="wh_topic_body">
<button id="wh_close_publication_toc_button" class="close-toc-button d-none" aria-label="Toggle publishing table of content" aria-controls="wh_publication_toc" aria-expanded="true">
<span class="close-toc-icon-container">
<span class="close-toc-icon"></span>
</span>
</button>
<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" title="Edit this document" href="http://172.16.35.88/tasks/jdssno1uvvbf2mltu9kb9v3if05d5gopuakboe8hlud18rma/edit/F:/aicdita/aicdita-cn/topics/sdk/usb/usb-aic_udc_driver.dita">Edit online</a></span><h1 class="- topic/title title topictitle1" id="ariaid-title1">AIC UDC Driver</h1>
<div class="date inPage">15 Jan 2024</div><div style="color: gray;">
Read time: 1 minute(s)
</div>
<div class="- topic/body concept/conbody body conbody">
<p class="- topic/p p" data-ofbid="d133069e33__20250123155212"><code class="+ topic/ph pr-d/codeph ph codeph">UDC Driver</code> 在需要完成的工作有两点:</p>
<ul class="- topic/ul ul" id="usb_aic_udc_driver__ul_u4y_nqz_21c" data-ofbid="usb_aic_udc_driver__ul_u4y_nqz_21c">
<li class="- topic/li li" data-ofbid="d133069e40__20250123155212">
<p class="- topic/p p" data-ofbid="d133069e42__20250123155212">把 UDC 硬件注册成标准的 Gadget Device以便提供标准的 Gadget API 给 Gadget Function 驱动来使用。</p>
</li>
<li class="- topic/li li" data-ofbid="d133069e46__20250123155212">
<p class="- topic/p p" data-ofbid="d133069e48__20250123155212">提供 endpoint 资源池,处理 endpoint 层级的数据收发。</p>
</li>
<li class="- topic/li li" data-ofbid="d133069e52__20250123155212">
<p class="- topic/p p" data-ofbid="d133069e54__20250123155212">需要处理部分 Endpoint0 Setup 逻辑。</p>
</li>
</ul>
<section class="- topic/section section" id="usb_aic_udc_driver__section_qjy_pqz_21c" data-ofbid="usb_aic_udc_driver__section_qjy_pqz_21c"><h2 class="- topic/title title sectiontitle">Init</h2>
<div class="- topic/p p" data-ofbid="d133069e64__20250123155212"><br/><div class="imagecenter"><img class="- topic/image image imagecenter" id="usb_aic_udc_driver__image_tks_4qz_21c" src="../../../images/usb/usb_udc_init.png" alt="image7"/></div><br/></div>
<p class="- topic/p p" data-ofbid="d133069e71__20250123155212">UDC 驱动把资源初始化好以后,注册成一个标准的 gadget 设备。</p>
</section>
<section class="- topic/section section" id="usb_aic_udc_driver__section_uks_4qz_21c" data-ofbid="usb_aic_udc_driver__section_uks_4qz_21c"><h2 class="- topic/title title sectiontitle">gadget.ops</h2>
<p class="- topic/p p" data-ofbid="d133069e80__20250123155212">UDC 驱动需要提供 gadget 设备的操作函数集 <code class="+ topic/ph pr-d/codeph ph codeph">gadget.ops</code>。简单定义如下:</p>
<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="usb_aic_udc_driver__pre_vks_4qz_21c" data-ofbid="usb_aic_udc_driver__pre_vks_4qz_21c"><code>staticconststructusb_gadget_opsaic_usb_gadget_ops={.get_frame=aic_gg_getframe,.udc_start=aic_gg_udc_start,.udc_stop=aic_gg_udc_stop,.pullup=aic_gg_pullup,.vbus_session=aic_gg_vbus_session,.vbus_draw=aic_gg_vbus_draw,};</code></pre>
<p class="- topic/p p" data-ofbid="d133069e89__20250123155212">其中的核心函数为 <code class="+ topic/ph pr-d/codeph ph codeph">.udc_start()</code> ,在调用该函数以后 UDC 才真正进入工作状态。其主要流程如下:</p>
<div class="- topic/p p" data-ofbid="d133069e95__20250123155212"><br/><div class="imagecenter"><img class="- topic/image image imagecenter" id="usb_aic_udc_driver__image_wks_4qz_21c" src="../../../images/usb/usb_udc_start.png" alt="image8"/></div><br/></div>
</section>
<section class="- topic/section section" id="usb_aic_udc_driver__section_xks_4qz_21c" data-ofbid="usb_aic_udc_driver__section_xks_4qz_21c"><h2 class="- topic/title title sectiontitle">ep.ops</h2>
<p class="- topic/p p" data-ofbid="d133069e108__20250123155212">UDC 驱动需要提供 endpoint 的操作函数集 <code class="+ topic/ph pr-d/codeph ph codeph">ep.ops</code>。简单定义如下:</p>
<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="usb_aic_udc_driver__pre_yks_4qz_21c" data-ofbid="usb_aic_udc_driver__pre_yks_4qz_21c"><code>staticconststructusb_ep_opsaic_usb_ep_ops={.enable=aic_ep_enable,.disable=aic_ep_disable,.alloc_request=aic_ep_alloc_request,.free_request=aic_ep_free_request,.queue=aic_ep_queue_request,.dequeue=aic_ep_dequeue_request,.set_halt=aic_ep_sethalt,};</code></pre>
<p class="- topic/p p" data-ofbid="d133069e117__20250123155212">其中 <code class="+ topic/ph pr-d/codeph ph codeph">.queue()</code> 函数负责接收 Gadget Function 驱动发送下来的
<code class="+ topic/ph pr-d/codeph ph codeph">usb_request</code>。其主要流程如下:</p>
<div class="- topic/p p" data-ofbid="d133069e126__20250123155212"><br/><div class="imagecenter"><img class="- topic/image image imagecenter" id="usb_aic_udc_driver__image_zks_4qz_21c" src="../../../images/usb/usb_udc_queue.png" alt="image9"/></div><br/></div>
</section>
<section class="- topic/section section" id="usb_aic_udc_driver__section_als_4qz_21c" data-ofbid="usb_aic_udc_driver__section_als_4qz_21c"><h2 class="- topic/title title sectiontitle">Interrupt</h2>
<p class="- topic/p p" data-ofbid="d133069e140__20250123155212">UDC 驱动主要承担的是数据收发,在上一节收到 <code class="+ topic/ph pr-d/codeph ph codeph">usb_request</code>
请求以后,接下来就是等待硬件处理完成产生中断了。中断处理的主要流程如下:</p>
<div class="- topic/p p" data-ofbid="d133069e146__20250123155212"><br/><div class="imagecenter"><img class="- topic/image image imagecenter" id="usb_aic_udc_driver__image_bls_4qz_21c" src="../../../images/usb/usb_udc_interrupt_flow.png" alt="image10"/></div><br/></div>
</section>
<section class="- topic/section section" id="usb_aic_udc_driver__section_cls_4qz_21c" data-ofbid="usb_aic_udc_driver__section_cls_4qz_21c"><h2 class="- topic/title title sectiontitle">EP0 Setup</h2>
<p class="- topic/p p" data-ofbid="d133069e159__20250123155212">UDC 驱动还有一项重要工作就是负责 EP0 Control 状态机的处理。USB ep0 上的 Control Transfer 处理分为 3 个阶段:
<code class="+ topic/ph pr-d/codeph ph codeph">Setup Stage</code><code class="+ topic/ph pr-d/codeph ph codeph">Data In/Out Stage</code>
<code class="+ topic/ph pr-d/codeph ph codeph">Status In/Out Stage</code> 。具体对应以下 5 种状态:</p>
<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="usb_aic_udc_driver__pre_dls_4qz_21c" data-ofbid="usb_aic_udc_driver__pre_dls_4qz_21c"><code><em class="hl-comment">/*Gadgetep0states*/</em>enumep0_state{EP0_SETUP,EP0_DATA_IN,EP0_DATA_OUT,EP0_STATUS_IN,EP0_STATUS_OUT,};</code></pre>
<p class="- topic/p p" data-ofbid="d133069e174__20250123155212">这几种状态之间的转换流程如下所示:</p>
<div class="- topic/p p" data-ofbid="d133069e177__20250123155212"><br/><div class="imagecenter"><img class="- topic/image image imagecenter" id="usb_aic_udc_driver__image_els_4qz_21c" src="../../../images/usb/usb_udc_ep0_control.png" alt="image11"/></div><br/></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="#usb_aic_udc_driver__section_qjy_pqz_21c" data-tocid="usb_aic_udc_driver__section_qjy_pqz_21c">Init</a></div></li><li class="section-item"><div class="section-title"><a href="#usb_aic_udc_driver__section_uks_4qz_21c" data-tocid="usb_aic_udc_driver__section_uks_4qz_21c">gadget.ops</a></div></li><li class="section-item"><div class="section-title"><a href="#usb_aic_udc_driver__section_xks_4qz_21c" data-tocid="usb_aic_udc_driver__section_xks_4qz_21c">ep.ops</a></div></li><li class="section-item"><div class="section-title"><a href="#usb_aic_udc_driver__section_als_4qz_21c" data-tocid="usb_aic_udc_driver__section_als_4qz_21c">Interrupt</a></div></li><li class="section-item"><div class="section-title"><a href="#usb_aic_udc_driver__section_cls_4qz_21c" data-tocid="usb_aic_udc_driver__section_cls_4qz_21c">EP0 Setup</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-23
</div>
</div>
</div>
</footer>
<button id="go2top" class="d-print-none" title="返回顶部">
<span class="oxy-icon oxy-icon-up"></span>
</button>
<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>