Files
luban-lite-t3e-pro/doc/topics/sdk/spinand/spi-nand_lib_design_guide.html

536 lines
63 KiB
HTML
Raw Normal View History

2025-01-23 16:37:00 +08:00
<!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="SPINAND 库数据结构设计 struct aic_spinand 定义了 SPINAND 控制器管理信息: struct aic_spinand { const struct aic_spinand_info *info; struct spinand_id id; void *user_data; void *lock; u8 use_continuous_read; u8 ..."/><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="topic"/><meta name="DC.relation" content="../../../topics/sdk/spinand/spi-nand-user-guide_2.html"/><meta name="DC.relation" content="../../../topics/sdk/spinand/spi-nand_test_guide.html"/><meta name="DC.relation" content="../../../topics/sdk/spinand/spi-nand_rtos_design_guide_lite.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="id"/><meta name="DC.language" content="zh-CN"/><title>SPINAND 库设计说明</title><!-- Build number 2023110923. --><meta name="wh-path2root" content="../../../"/><meta name="wh-toc-id" content="id-d5856e3555"/><meta name="wh-source-relpath" content="topics/sdk/spinand/spi-nand_lib_design_guide.dita"/><meta name="wh-out-relpath" content="topics/sdk/spinand/spi-nand_lib_design_guide.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="id" 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 "><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="chapter-memory"><div class="title"><a href="../../../topics/chapter-title/chapter-memory-sdk.html">存储</a><div class="wh-tooltip"><p class="shortdesc">SDMC、SPI NAND、SPI NOR<span class="ph"> 以及文件系统</span> 等存储模块的介绍和使用说明。</p></div></div></div></li><li><div class="topicref" data-id="spi_nand_user_guide"><div class="title"><a href="../../../topics/sdk/spinand/spi-nand-user-guide_2.html">SPI NAND 使用指南</a></div></div></li><li class="active"><div class="topicref" data-id="id"><div class="title"><a href="../../../topics/sdk/spinand/spi-nand_lib_design_guide.html">SPINAND 库设计说明</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/spinand/spi-nand_test_guide.html" title="测试指南" aria-label="上一主题: 测试指南" rel="prev"></a></span>
<span class="navnext"><a class="- topic/link link" href="../../../topics/sdk/spinand/spi-nand_rtos_design_guide_lite.html" title="RTOS 设计说明" aria-label="下一主题: RTOS 设计说明" 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-d5856e989" 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_rtos.html" id="revinfo_linux-d5856e989-link">修订记录</a></div></div></li><li role="treeitem" aria-expanded="false"><div data-tocid="id-d5856e1003" class="topicref" data-id="id" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action id-d5856e1003-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/env/sdk-compile.html" id="id-d5856e1003-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="id-d5856e1152" class="topicref" data-id="id" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action id-d5856e1152-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/advanced/sdk-usage.html" id="id-d5856e1152-link">使用指南</a><div class="wh-tooltip"><p class="shortdesc">系统镜像、编译选项、开发板、应用等相关的详细使用说明。</p></div></div></div></li><li role="treeitem" aria-expanded="false"><div data-tocid="concept_rcx_czh_pzb-d5856e1416" 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-d5856e1416-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/chapter-app.html" id="concept_rcx_czh_pzb-d5856e1416-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-d5856e2119" class="topicref" data-id="id" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action id-d5856e2119-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/peripheral/peripheral-intro.html" id="id-d5856e2119-link">外设移植</a><div class="wh-tooltip"><p class="shortdesc"><span class="ph">CTP、U 盘、SD 卡、有线和无线网络</span>等外设的介绍和使用说明。</p></div></div></div></li><li role="treeitem" aria-expanded="false"><div data-tocid="id-d5856e2244" class="topicref" data-id="id" data-state="not-ready"><span role="button" tabindex="0" aria-labelledby="button-expand-action id-d5856e2244-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/bringup/chapter-bringup.html" id="id-d5856e2244-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-d5856e2345" class="topicref" data-id="id" data-state="expanded"><span role="button" tabindex="0" aria-labelledby="button-collapse-action id-d5856e2345-link" class="wh-expand-btn"></span><div class="title"><a href="../../../topics/sdk/chapter-advanced-app.html" id="id-d5856e2345-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="_0-d5856e2360" class="topicref" data-id="_0" data-state="not-ready"><spa
</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 topic" 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/spinand/spi-nand_lib_design_guide.dita">Edit online</a></span><h1 class="- topic/title title topictitle1" id="ariaid-title1">SPINAND 库设计说明</h1><div class="date inPage">15 Jan 2024</div><div style="color: gray;">
Read time: 6 minute(s)
</div><div class="- topic/body body"><section class="- topic/section section" id="id__spinand" data-ofbid="id__spinand"><h2 class="- topic/title title sectiontitle">SPINAND 库数据结构设计</h2>
<div class="- topic/div div section" id="id__struct-aic-spinand">
<strong class="+ topic/ph hi-d/b ph b">struct aic_spinand</strong>
<div class="- topic/p p" data-ofbid="d43490e29__20250121171517">定义了 SPINAND 控制器管理信息:<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="id__codeblock_kfk_4p3_ddc" data-ofbid="id__codeblock_kfk_4p3_ddc"><strong class="hl-keyword">struct</strong> aic_spinand {
<strong class="hl-keyword">const</strong> <strong class="hl-keyword">struct</strong> aic_spinand_info *info;
<strong class="hl-keyword">struct</strong> spinand_id id;
<strong class="hl-keyword">void</strong> *user_data;
<strong class="hl-keyword">void</strong> *lock;
u8 use_continuous_read;
u8 qspi_dl_width;
u8 IsInited;
u8 *databuf;
u8 *oobbuf;
<strong class="hl-keyword">struct</strong> nand_bbt bbt;
};</pre><div class="- topic/note note tip note_tip" id="id__note_qfr_qn3_ddc" data-ofbid="id__note_qfr_qn3_ddc"><span class="note__title">提示:</span>
<p class="- topic/p p" data-ofbid="d43490e35__20250121171517"><code class="+ topic/ph pr-d/codeph ph codeph">info</code> 表示 SPINAND 设备信息
<code class="+ topic/ph pr-d/codeph ph codeph">use_continuous_read</code> 表示 SPINAND 使能了连续读取模式(部分厂家芯片支持)
<code class="+ topic/ph pr-d/codeph ph codeph">qspi_dl_width</code> 表示 qspi 总线数据宽度 <code class="+ topic/ph pr-d/codeph ph codeph">bbt</code>
表示坏块管理信息</p>
</div></div>
</div>
<div class="- topic/div div section" id="id__struct-aic-spinand-info">
<strong class="+ topic/ph hi-d/b ph b">struct aic_spinand_info</strong>
<div class="- topic/p p" data-ofbid="d43490e56__20250121171517">定义了 SPINAND
设备配置信息<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="id__codeblock_bhc_pp3_ddc" data-ofbid="id__codeblock_bhc_pp3_ddc"><em class="hl-comment">/* SPI NAND flash information */</em>
<strong class="hl-keyword">struct</strong> aic_spinand_info {
u32 devid;
u16 page_size;
u16 oob_size;
u32 block_per_lun;
u32 pages_per_eraseblock;
u8 is_die_select;
<strong class="hl-keyword">const</strong> <strong class="hl-keyword">char</strong> *sz_description;
<strong class="hl-keyword">struct</strong> spi_nand_cmd_cfg *cmd;
};</pre></div>
</div>
<div class="- topic/div div section" id="id__struct-spi-nand-cmd-cfg">
<strong class="+ topic/ph hi-d/b ph b">struct spi_nand_cmd_cfg</strong>
<div class="- topic/p p" data-ofbid="d43490e67__20250121171517">定义了 SPINAND
操作命令配置的格式<pre class="+ topic/pre pr-d/codeblock pre codeblock language-c" id="id__codeblock_aw3_pp3_ddc" data-ofbid="id__codeblock_aw3_pp3_ddc"><strong class="hl-keyword">struct</strong> spi_nand_cmd_cfg {
u8 opcode;
u8 opcode_bits;
u8 addr_bytes;
u8 addr_bits;
u8 dummy_bytes;
u8 data_bits;
};</pre></div>
</div>
</section><section class="- topic/section section" id="id__id5" data-ofbid="id__id5"><h2 class="- topic/title title sectiontitle">SPINAND 库相关接口介绍</h2>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_bjw_dzh_bdc" data-ofbid="id__table_bjw_dzh_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">spinand_flash_init</span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">int spinand_flash_init(struct aic_spinand *flash);</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">初始化 spinand 芯片</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">-</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_cjw_dzh_bdc" data-ofbid="id__table_cjw_dzh_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">spinand_read_id_op</span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">int spinand_read_id_op(struct aic_spinand *flash, u8
*id);</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">读取 spinand 芯片的 id</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u8 *id</div>
<div class="- topic/div div">
<div class="- topic/div div">读取 spinand id 缓存地址</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">- </td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_djw_dzh_bdc" data-ofbid="id__table_djw_dzh_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"> 3</span><span class="table--title-label-punctuation">. </span></span><span class="table--title">spinand_read</span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">int spinand_read(struct aic_spinand *flash, u8 *addr, u32 offset,
u32 size);</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">从 spinand 读取数据</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u8 *addr</div>
<div class="- topic/div div">
<div class="- topic/div div">读取 spinand 数据缓存地址</div>
</div>
<div class="- topic/div div">u32 offset</div>
<div class="- topic/div div">
<div class="- topic/div div">从 spinand 读取数据的偏移地址</div>
</div>
<div class="- topic/div div">u32 size</div>
<div class="- topic/div div">
<div class="- topic/div div">从 spinand 读取数据的长度</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">offset 需要与 page 大小对齐</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_ejw_dzh_bdc" data-ofbid="id__table_ejw_dzh_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"> 4</span><span class="table--title-label-punctuation">. </span></span><span class="table--title"><strong class="+ topic/ph hi-d/b ph b">spinand_write</strong></span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">int spinand_write(struct aic_spinand *flash, u8 *addr, u32
offset, u32 size);</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">写入数据到 spinand</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u8 *addr</div>
<div class="- topic/div div">
<div class="- topic/div div">写入 spinand 数据缓存地址</div>
</div>
<div class="- topic/div div">u32 offset</div>
<div class="- topic/div div">
<div class="- topic/div div">写入 spinand 数据的偏移地址</div>
</div>
<div class="- topic/div div">u32 size</div>
<div class="- topic/div div">
<div class="- topic/div div">写入 spinand 数据的长度</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">offset 需要与 page 大小对齐</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_fjw_dzh_bdc" data-ofbid="id__table_fjw_dzh_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"> 5</span><span class="table--title-label-punctuation">. </span></span><span class="table--title"><strong class="+ topic/ph hi-d/b ph b">spinand_erase</strong></span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">int spinand_erase(struct aic_spinand *flash, u32 offset, u32
size);</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">擦除 spinand 数据</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u32 offset</div>
<div class="- topic/div div">
<div class="- topic/div div">擦除 spinand 数据的偏移地址</div>
</div>
<div class="- topic/div div">u32 size</div>
<div class="- topic/div div">
<div class="- topic/div div">擦除 spinand 数据的长度</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">offset 和 size 需要与 block 大小对齐</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_gjw_dzh_bdc" data-ofbid="id__table_gjw_dzh_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"> 6</span><span class="table--title-label-punctuation">. </span></span><span class="table--title"><strong class="+ topic/ph hi-d/b ph b">spinand_block_erase</strong></span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">int spinand_block_erase(struct aic_spinand *flash, u16
blk);</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">擦除 spinand 指定块地址的块数据</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u16 blk</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 块地址</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">-</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_hjw_dzh_bdc" data-ofbid="id__table_hjw_dzh_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"> 7</span><span class="table--title-label-punctuation">. </span></span><span class="table--title"><strong class="+ topic/ph hi-d/b ph b">spinand_block_isbad</strong></span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">int spinand_block_isbad(struct aic_spinand *flash, u16
blk);</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">判断 spinand 指定块地址的块是否是坏块</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u16 blk</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 块地址</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">-</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_ijw_dzh_bdc" data-ofbid="id__table_ijw_dzh_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"> 8</span><span class="table--title-label-punctuation">. </span></span><span class="table--title"><strong class="+ topic/ph hi-d/b ph b">spinand_block_markbad</strong></span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">int spinand_block_markbad(struct aic_spinand *flash, u16
blk);</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">标记 spinand 指定块地址的块为坏块</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u16 blk</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 块地址</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">-</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_jjw_dzh_bdc" data-ofbid="id__table_jjw_dzh_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"> 9</span><span class="table--title-label-punctuation">. </span></span><span class="table--title"><strong class="+ topic/ph hi-d/b ph b">spinand_read_page</strong></span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">int spinand_read_page(struct aic_spinand *flash, u32 page,
u8 *data,</div>
<div class="- topic/div div">
<div class="- topic/div div">u32 data_len, u8 *spare, u32 spare_len);</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">读取 spinand 指定 page 上的数据</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u32 page</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 页地址</div>
</div>
<div class="- topic/div div">u8 *data</div>
<div class="- topic/div div">
<div class="- topic/div div">读 page 主区域数据的缓存地址</div>
</div>
<div class="- topic/div div">u32 data_len</div>
<div class="- topic/div div">
<div class="- topic/div div">读 page 主区域数据的长度</div>
</div>
<div class="- topic/div div">u8 *spare</div>
<div class="- topic/div div">
<div class="- topic/div div">读 page spare 区域数据的缓存地址</div>
</div>
<div class="- topic/div div">u32 spare_len</div>
<div class="- topic/div div">
<div class="- topic/div div">读 page spare 区域数据的长度</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">-</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_kjw_dzh_bdc" data-ofbid="id__table_kjw_dzh_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"> 10</span><span class="table--title-label-punctuation">. </span></span><span class="table--title"><strong class="+ topic/ph hi-d/b ph b">spinand_write_page</strong></span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">int spinand_write_page(struct aic_spinand *flash, u32 page,
const u8 *data,</div>
<div class="- topic/div div">
<div class="- topic/div div">u32 data_len, const u8 *spare, u32 spare_len);</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">写入数据到 spinand 指定 page 上</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u32 page</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 页地址</div>
</div>
<div class="- topic/div div">u8 *data</div>
<div class="- topic/div div">
<div class="- topic/div div">写 page 主区域数据的缓存地址</div>
</div>
<div class="- topic/div div">u32 data_len</div>
<div class="- topic/div div">
<div class="- topic/div div">写 page 主区域数据的长度</div>
</div>
<div class="- topic/div div">u8 *spare</div>
<div class="- topic/div div">
<div class="- topic/div div">写 page spare 区域数据的缓存地址</div>
</div>
<div class="- topic/div div">u32 spare_len</div>
<div class="- topic/div div">
<div class="- topic/div div">写 page spare 区域数据的长度</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">-</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_ljw_dzh_bdc" data-ofbid="id__table_ljw_dzh_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"> 11</span><span class="table--title-label-punctuation">. </span></span><span class="table--title"><strong class="+ topic/ph hi-d/b ph b">spinand_continuous_read</strong></span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">int spinand_continuous_read(struct aic_spinand *flash, u32
page, u8 *data, u32 size);</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">使用连续读取模式读取 spinand 上指定长度的数据</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u32 page</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 页地址</div>
</div>
<div class="- topic/div div">u8 *data</div>
<div class="- topic/div div">
<div class="- topic/div div">读 spinand 数据的缓存地址</div>
</div>
<div class="- topic/div div">u32 size</div>
<div class="- topic/div div">
<div class="- topic/div div">读 spinand 数据的长度</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">size 需要大于等于 2 个 page 大小</td></tr></tbody></table></div>
<div class="table-container"><table class="- topic/table table colwidths-given docutils align-default frame-all" id="id__table_mjw_dzh_bdc" data-ofbid="id__table_mjw_dzh_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"> 12</span><span class="table--title-label-punctuation">. </span></span><span class="table--title"><strong class="+ topic/ph hi-d/b ph b">spinand_config_set</strong></span></caption><colgroup><col style="width:16.666666666666664%"/><col style="width:83.33333333333334%"/></colgroup><tbody class="- topic/tbody tbody"><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 函数原型 </td><td class="- topic/entry entry colsep-0 rowsep-1">int spinand_config_set(struct aic_spinand *flash, u8 mask, u8
val);</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 功能说明 </td><td class="- topic/entry entry colsep-0 rowsep-1">设置 spinand 配置寄存器的值</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 参数定义 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">struct aic_spinand *flash</div>
<div class="- topic/div div">
<div class="- topic/div div">spinand 设备对象</div>
</div>
<div class="- topic/div div">u8 mask</div>
<div class="- topic/div div">
<div class="- topic/div div"> 配置寄存器的掩码</div>
</div>
<div class="- topic/div div">u8 val</div>
<div class="- topic/div div">
<div class="- topic/div div"> 配置寄存器的值</div>
</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-1"> 返回值 </td><td class="- topic/entry entry colsep-0 rowsep-1">
<div class="- topic/div div">
<div class="- topic/div div">0: 成功</div>
<div class="- topic/div div">其他: 失败</div>
</div>
</td></tr><tr class="- topic/row"><td class="- topic/entry entry colsep-1 rowsep-0"> 注意事项 </td><td class="- topic/entry entry colsep-0 rowsep-0">-</td></tr></tbody></table></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="#id__spinand" data-tocid="id__spinand">SPINAND 库数据结构设计</a></div></li><li class="section-item"><div class="section-title"><a href="#id__id5" data-tocid="id__id5">SPINAND 库相关接口介绍</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>