S12(X)微控制器的Bootloader程序

╰+哭是因爲堅強的太久メ 2022-06-06 03:42 268阅读 0赞

需要实现远程升级单片机，正好在网上找到了官方提供的Bootloader程序及其对应的文档，赶快弄下来学习研究，这是对其文档的翻译。

翻译的资料是公开的，在这里下载[https://www.nxp.com/products/microcontrollers-and-processors/additional-processors-and-mcus/8-16-bit-mcus/16-bit-s12-and-s12x-mcus/ultra-reliable-s12xe-high-performance-automotive-and-industrial-microcontrollers:S12XE?tab=Documentation\_Tab][https_www.nxp.com_products_microcontrollers-and-processors_additional-processors-and-mcus_8-16-bit-mcus_16-bit-s12-and-s12x-mcus_ultra-reliable-s12xe-high-performance-automotive-and-industrial-microcontrollers_S12XE_tab_Documentation_Tab]，我想应该不会有什么版权问题，如涉及版权问题，请联系我删除文章。另感谢NXP提供的学习资料。

--------------------

实测在MC9S12XEP100上可以使用，但是对我来说需要修改了一个小地方：  
可能是由于这个程序的版本太老，PARTID没有考虑到我手头上这个XEP100的PARTID(0xCC95)，这个PARTID甚至在芯片手册中都没有提到，不过问题也不大，测试后发现只要和0xCC94一样的处理方法即可了。想知道自己设备的PARTID是多少可以直接去看地址在1A-1B的这两个字节的值是多少。

修改方式为：  
首先在PARTID.h中添加一个宏

……
    //S12XE:
    #define MASK_0M48H 0xCC90       //1024k flash
    #define MASK_1M48H 0xCC91
    #define MASK_2M48H 0xCC92
    #define MASK_3M48H 0xCC93
    #define MASK_4M48H_5M48H 0xCC94
    #define MASK_5M48H 0xCC95      // 添加的
    ……

然后在main.c 中的EraseFlash和ProgramFlash两个函数中的switch语句中分别添加一行case。

……
              //S12XE 1024k flash
              case MASK_0M48H:  //Falling to next case
              case MASK_1M48H:  //Falling to next case
              case MASK_2M48H:  //Falling to next case
              case MASK_3M48H:  //Falling to next case
              case MASK_4M48H_5M48H:
              case MASK_5M48H:  // 添加的
                    if (!((ProgSRec.LoadAddr >= 0x700000UL) && (ProgSRec.LoadAddr <= 0x7FEFDFUL)))
                      return(SRecRangeError);
                    break;
    ……

然后就能按照指南正常运行了。

--------------------

## 180nm微控制器 S12(X)的串行Bootloader ##

by: Lukas Zadrapa and Ladislav Makovic  
Technical Information Center  
Roznov  
Czech Republic

译者注：译者博客([http://blog.csdn.net/lin\_strong][http_blog.csdn.net_lin_strong])，转载请保留这条。此为官方文档AN4258，仅供学习交流使用，请勿用于商业用途。

# 介绍 #

这篇应用笔记介绍了为 基于180nm技术的 S12和S12X微控制器家族 编写的一个bootloader程序的运行和使用。

使用这bootloader可以很方便地实现生产中编程或者“在线系统(in-system)”编程，特别是应用于那些 无法使用HCS12背景调试接口(BDM)的场合。用户必须在生产准备阶段或在编程供应商那把bootloader预先烧写进S12(X)。Bootloader会留存在MCU中以供未来使用。

这个bootloader实现支持通过SCI串口将用户软件下载进MCU flash内存中。

这篇文档中描述的bootloader只是一个示例，由其产生的任何后果我们概不负责，并且我们不提供技术支持。

# 硬件兼容性 #

有两个版本的bootloader：

*  第一个是为S12系列(S12P、S12HY、S12HA和S12G)写的。
 *  第二个是为S12X系列(S12XS、S12XE和S12XF)写的。

除非特别标注，这篇应用笔记中的内容适用于所有两个版本。

这个bootloader没有为最小的设备进行优化。因此，不支持MC9S12GN16。

当前不支持对D-Flash或说EEPROM的编程。

# 需求 #

为了成功运行这个bootloader，需要满足一些需求。

## 输入引脚 ##

有许多种方式确定是要启动bootloader还是用户应用程序。比如可以选择通过判断输入引脚的状态、通过EEPROM内存中的某个变量的状态或者通过从通讯接口收到的命令。

这个bootloader使用第一种方式。在重置之后，bootloader会使能PP0引脚的上拉寄存器并且读取PP0引脚的状态以确定是否你想要运行bootloader。

可能这个引脚的外部电路是这样的：一个开关、跳线或者一个按钮与可选的上拉电阻器。

![引脚连接][SouthEast]  
图 1.引脚连接

## 串行接口 ##

所有的S12(X)微控制器都有集成串行通信接口。注意，需要RS232电平转换器以与PC通信。

默认的，串行通信会设为这个格式：

*  8数据位
 *  1起始位
 *  1停止位
 *  0校验位
 *  Xon/Xoff 流控制

默认的波特率是9600。可以在bootloader的菜单中修改其为38400、57600或115200 bps。

## 终端模拟程序 ##

可以使用串口调试助手来与PC通信。这个串口调试器必须支持串行COM口通信、Xon/Xoff流控制以及必须支持发送文本文件。

## 振荡器 ##

S12微控制器不需要外部晶振。bootloader会使用S12微控制器内部的一个1MHz的RC震荡电路。Bootloader设置总线频率为25MHz以支持高速率通信。

S12X微控制器需要晶振或者外部振荡器。在bootloader内配置PLL以达到40MHz的总线时钟频率。这是为了提高通信速率以加快代码下载速度。

# 功能描述 #

bootloader的运作方式很直白。这个部分仅描述了最重要的和最特殊的那些。

## 运作 ##

bootloader会处理所有的重置向量。在重置后，会调用bootloader的startup例程。首先，bootloader会读取PP0引脚的状态。如果引脚值为逻辑0，bootloader就会开始工作。如果是逻辑1，就会调用用户应用程序的startup例程。如果用户应用的重置向量不可用(地址0xEFFE-0xEFFF上的字被擦除)，那不管怎么样bootloader都会开始运行。用户可以重写这个代码以更改启动条件。

## 中断向量 ##

在用户应用用到了中断的情况下，需要使用IVBR寄存器重定位中断向量表。bootloader被放在最高的一个地址块中，地址0xF000-0xFFFF。这个区域是受保护的，所以用户的应用程序不能把中断向量表放在默认的地址0xFF10-0xFFFF。这种方案的优点是bootloader不会受到电源故障的影响，这可能会在重写中断和重置向量时发生。

## 掩码组与part ID ##

每个硅掩码组都有一个特定的part ID，位于两个8位寄存器中，PARTIDH和PARTIDL中，地址在0x001A和0x001B。

当要把s-record编程到flash内存中去时，bootloader会检查是否地址位于物理flash内存上。当地址无效时，会返回一个错误。

在bootloader工程的PartID.h文件中可以找到当前支持的掩码组和part ID。

# 用户指南 #

这个部分描述了使用这个bootloader的每一步。

## 配置S12的bootloader ##

1.  在CodeWarrior for S12(X)集成开发环境中打开Bootloader\_S12工程。bootloader在v5.0和v5.1中测试过了。
2.  如图2选择target。  
    ![S12 target选项][S12 target]  
    图 2.S12 target选项
3.  通过引脚PP0来决定是启动bootloader还是用户应用程序。如果PP0是低电平，就会启动bootloader，如果PP0是高电平，就会启动用户应用程序。如果这个默认配置不好用，用户可以在Start12.s中重写这个代码。

## 配置S12X的bootloader ##

1.  在CodeWarrior for S12(X)集成开发环境中打开Bootloader\_S12X工程。bootloader在v5.0和v5.1中测试过了。
2.  打开文件Config.h并进行如下设置：  
    设置FLASH\_PRESCALER(加载到FCLKDIV寄存器中的值)以让flash运行频率在800-1050kHz间，如参考手册所述。  
    设置PLL以使总线频率达到40MHz。可以利用这个应用笔记附带的PLL计算器。
3.  如图3选择target。  
    ![S12X target选项][S12X target]  
    图 3.S12X target选项
4.  通过引脚PP0来决定是启动bootloader还是用户应用程序。如果PP0是低电平，就会启动bootloader，如果PP0是高电平，就会启动用户应用程序。如果这个默认配置不好用，用户可以在StartS12X.s中重写这个代码。

## Bootloader指南 ##

1.  编译工程并通过BDM设备下载bootloader到MCU中去。
2.  打开串口调试助手。设置波特率为9600，1个起始位，8数据位，1数据位，流控制Xon/Xoff。
3.  用串行连接线连接PC和开发板。
4.  让PP0为低电平，然后重启MCU。
5.  bootloader就启动了，然后你会在串口调试助手中看到如下信息。见图4。  
    ![最初的界面][SouthEast 1]  
    图 4.最初的界面
6.  输入“a”以擦除flash内存。第一次不需要这一步，因为flash已经被BDM设备擦除了。
7.  输入“b”以编程flash。
8.  现在将用到的S-record作为文本文件发送—见图5。浏览被下载到MCU中的S-record。  
    为了测试目的，使用附加到这个应用笔记上的示例S-records。S-records必须使用特定的格式。请参考章节6，“怎么写用户应用程序”以及章节7，“怎么转换将被bootloader下载的S-Record”。  
    ![发送文本文件][SouthEast 2]  
    图 5.发送文本文件
9.  确定对话框和S-record已经被下载到MCU中去了。一个星号(\*)代表编程成功了一行。见图6。  
    ![下载用户应用][SouthEast 3]  
    图 6.下载用户应用

# 怎么写用户应用程序 #

你必须确保用户应用程序不会碰到bootloader的地址范围(0xF000-0xFFFF)。  
1. 在CodeWarrior for S12(X)集成开发环境中创建一个新工程。  
2. 打开.prm文件  
3. 把segment ROM\_C000从原来的0xC000-0xFEFF改成0xC000-0xEFDF。这是因为地址0xF000-0xFFFF会放着bootloader，而0xEFE0-0xEFFF会用作用户应用的重置向量。  
  
如果使用了中断：  
4. 把segment ROM\_4000从原来的0x4000-0x7FFF改成0x4000-0x7F0F。0x7F10-0x7FFF会被用于重定位中断向量表。  
5. 如附件示例应用那样创建一个中断向量表，并对应的设置IVBR寄存器。IVBR设置中断向量表的基地址，这种情况下必须被设置为0x7F。

# 怎么转换将被bootloader下载的S-Record #

bootloader接受使用全局(线性)地址的s-records。所有的records必须被对齐为32字节，长度也必须是32字节。  
1. 打开SRecCvt工具(SRecCvt-GUI.exe)  
2. 选择使用的MC9S12设备(取决你用的是哪个)，选择Memory为Flash，选择Operation为Convert File。  
3. 选择输入文件格式为Banked，输出文件格式为Linear。  
4. 设置S-Record Size为32.  
5. 浏览输入文件(由CodeWarrior生成的S19文件)并选择输出文件。  
6. 点击Convert按钮。  
![SRecCvt][]  
图 7.SRecCvt

# 怎么合并用户应用和bootloader #

用户应用可以被独立地开发，或说，不带有bootloader。用户应用可以被加载进微控制器并可以由BDM设备来直接的调试。然而，出于生产目的，将用户应用与bootloader合并到一起是很有价值的，这样就可以在单个s-record文件中把所有东西都下载进微控制器了。

这是推荐的流程：  
1. 打开按照第6章“怎么写用户应用程序”中所述那样创建的用户应用程序。  
2. 把一个用户应用程序重置向量放到地址0xEFFE，这样bootloader就可以使用这个向量了。拷贝以下三行到main.c中：

*  extern void near \_Startup(void)
 *  typedef void (\*near tFunc)(void)
 *  const tFunc rst\_vec @0xEFFE = \_Startup
 *    
    3. 移除原先的用户应用程序重置向量。  
    在Project.prm文件中注释掉这行：  
    //VECTOR 0 \_Startup  
    4. 复制准备好了的bootloader .s19文件到 ..\\user\_application\_project\\bin下。比如，s-record文件可以被重命名为bootloader.s19  
    5. 链接这个文件到用户应用程序中。  
    在Project.prm的开头加上这个命令：  
    HEXFILE bootloader.s19  
    6. 添加如下命令到文件..\\user\_application\_project\\cmd\\P&E\_Multilink\_CyclonePro\_Preload.cmd中：  
      
    FLASH NOUNSECURE  
      
    这个命令能确保烧写器不会在MCU编程过程中自动地改变0xFF0F处的flash安全字节为一个不安全状态(0xFE)，这样，这个phrase(0xFF08-0XFF0F)就可以被加载定义在bootloader中的值了。如果不使用这个命令，会导致在这个phrase发生ECC错误，芯片会被保护，并且flash会被完全保护。  
    7. 编译项目。最终的s-record就准备好被BDM设备下载入微控制器了。
    
    # 测试 #
    
    这个bootloaders在这些开发板上测试成功过：
    
     *  DEMO9S12PFAME
     *  DEMO9S12HY64
     *  TWR-S12G128
     *  DEMO9S12XSFAME
     *  EVB9S12XEP100
    
    # Zip文件的内容 #
    
    所有提到的工程和工具都在这篇应用笔记相关的zip文件中。
    
     *  Bootloader\_S12 — S12微控制器的bootloader工程。
     *  Bootloader\_S12X — S12X微控制器的bootloader工程。
     *  Demo\_applications — 示例怎么写用户应用程序的工程。
     *  Coverted\_srecords — 源于Demo\_applications的已经被SRecCvt工具转换好的S-Records。这些S-Records可以由bootloader下载进MCU中。
     *  Demo\_applications\_with\_linked\_bootloader — 包含bootloader的用户应用程序。
     *  SRecCvt — 用于转换S-Record的工具。
     *  S12XE\_PLL\_Calculator — 帮助设置PLL模块的工具。

[https_www.nxp.com_products_microcontrollers-and-processors_additional-processors-and-mcus_8-16-bit-mcus_16-bit-s12-and-s12x-mcus_ultra-reliable-s12xe-high-performance-automotive-and-industrial-microcontrollers_S12XE_tab_Documentation_Tab]: https://www.nxp.com/products/microcontrollers-and-processors/additional-processors-and-mcus/8-16-bit-mcus/16-bit-s12-and-s12x-mcus/ultra-reliable-s12xe-high-performance-automotive-and-industrial-microcontrollers:S12XE?tab=Documentation_Tab
[http_blog.csdn.net_lin_strong]: http://blog.csdn.net/lin_strong
[SouthEast]: /images/20220606/e0af665755bc4a00b18b65d69985a717.png
[S12 target]: /images/20220606/824bc8fbc5bd4380ac0ef12dfc55c942.png
[S12X target]: /images/20220606/039e3c2e43f145ad98addb998c857dbb.png
[SouthEast 1]: /images/20220606/8fcd81c3871e42378d5786d0ef06f1d4.png
[SouthEast 2]: /images/20220606/f1be9ecdd3b141f5b1f2dda5d5904ff2.png
[SouthEast 3]: /images/20220606/55faa68cf8674324b2b631430707d50d.png
[SRecCvt]: /images/20220606/3ab7ce03e3a54ae4bff7f00c780935ee.png