導言：我們發現，當客戶開發Non-OS的程序代碼，最常遇到的問題在于開發者不知如何撰寫linker script。網絡上有GNU ld的使用文件，但是linker script的范例太少，尤其開發者需要撰寫進階的linker script，常常不知如何下手。本篇文章我們分享如何實作ROM patch。

筆者曾協助多家公司工程師，在AndesCore™上發展firmware。我們發現，當客戶開發Non-OS的程序代碼，最常遇到的問題在于開發者不知如何撰寫linker script。網絡上有GNU ld的使用文件，但是linker script的范例太少，尤其開發者需要撰寫進階的linker script，常常不知如何下手。

本篇文章我們分享如何實作ROM patch。使用晶心CPU建構的embedded system，一般具有CPU、外圍IP及RAM、ROM。部份客戶使用ROM code開機，程序代碼放在ROM內，data section放在SRAM里。ROM code的特性是成本低，跟著IC光罩一起生產，當IC制作完成即不可修改，若有制作上的錯誤或是程序代碼邏輯上的錯誤，只能用ROM patch的方式修補。也就是將需要修補的程序代碼放到小容量的flash里。這就是我們今天要分享的技術。

1.    主程序架構

首先介紹主程序的架構。IC的Memory layout如下圖。

紅色框線的部份，為主程序編譯的范圍。主程序main會呼叫到func1、func2和func3這3個function。

在上圖中，黃色區域是IC的ROM，這部份的程序是IC制作出來即不可以改變。綠色部份是flash。在圖中，flash分成2區，一個是jump_table，存放func1~func3的地址。剩余的空間FUNC_PATCH，預留給patch使用。

為了要修補ROM內的function，所以規劃出jump_table區域，原本都是指向ROM的function。如果ROM里的部份function損壞或是需要改寫，就把jump_table改為指向FUNC_PATCH里新建的function。

1.1 源代碼

主程序的程序代碼如下：(main.c)
#include <stdio.h>
#include <stdlib.h>
int func1(int);
int func2(int);
int func3(int);
int num1=1;
int num2=2;
int num3=3;

typedef struct strfunptr {
   int (*func_a)(int);
   int (*func_b)(int);
   int (*func_c)(int);
}sfptr;

sfptr jump_table __attribute__ ((section ("FUNC_TABLE")))= {func1, func2, func3};

int main(void) {

    printf("func1(30)=%dn",jump_table.func_a(30));
    printf("func2(30)=%dn",jump_table.func_b(30));
    printf("func3(30)=%dn",jump_table.func_c(30));

    return EXIT_SUCCESS;
}
[page]
int func1(int x){
    return x*num1;
}
int func2(int x){
    return x*num2;
}
int func3(int x){
    return x*num3;
}

上面的程序代碼中，第16行的程序代碼__attribute__ ((section ("FUNC_TABLE")))，作用是將jump_table放在特定的”FUNC_TABLE”section里。

1.2 主程序linker script (僅列需要修改的部份)

  FUNC_TABLE 0x510000 :
    {
    *(.FUNC_TABLE)
     }

Flash的地址由0x510000起，將FUNC_TABLE固定在flash的最開頭，語法如上。

1.3 主程序執行結果

func1(30)=30
func2(30)=60
func3(30)=90

2.    經過Patch之后的架構圖

假設ROM里的func2損壞，要改用flash里的func2。需要更改指向func2的指標，及func2的內容。如下圖：

用紅色框線標起來的地方，表示為patch編譯的范圍。其中jump table在這里重新編譯，指向新的地址。
[page]
2.1 實作方法

(1) 導出主程序的symbol table。

在主程序的Linker flags 加上-Wl,--mgen-symbol-ld-script=export.txt ，ld 會產生export.txt這個檔案, 這個檔案包含了一個SECTION block以及許多變數的地址。如下圖所示

Linker script在import Main program的symbols時，除了需要修改的func2不要import之外，其他的symbols全部要import進來。(將export.txt刪去這一行：    func2 = 0x005001c4;     /* ./main.o */)

(2) patch在編譯之前，先匯入主程序的symbol table。(將export.txt檔案放在一起編譯)。Patch的linker script要匯入主程序的symbol，寫法如下面紅色字體。

ENTRY(_start)
/* Do we need any of these for elf?
   __DYNAMIC = 0;    */
INCLUDE "..export.txt" 
SECTIONS
{

(3) patch的程序代碼里如下，沒有main function，也不要加入startup files。改寫func2。func2放在flash的FUNC_PATCH section。并且將jump_table里的func2，改成指向新的func2。

#include <stdio.h>
#include <stdlib.h>

extern int func1(int);
extern int func3(int);
int func2(int) __attribute__ ((section ("FUNC_PATCH")));
extern int num2;

typedef struct strfunptr {
   int (*func_a)(int);
   int (*func_b)(int);
   int (*func_c)(int);
}sfptr;

sfptr jump_table __attribute__ ((section ("FUNC_TABLE")))= {func1, func2, func3};

int func2(int x){
    return x*num2*100;
}

 (4) patch的linker script，加入FUNC_PATH在jump_table之后。
FUNC_PATCH 0x510020 :
    {
    *(.FUNC_PATCH)
     }
[page]
3. 如何除錯

首先，將程序代碼存放在IC的ROM及flash里。(本文為了示范，我們的做法是在AndeShape™ ADP-XC5的FPGA板上，用RAM模擬ROM及flash，分別將主程序和patch的bin文件restore到板子上。)

當gdb debug時，載入patch 的symbol。以下節錄gdb指令。

core0(gdb) file mainprog.adx
core0(gdb) add-symbol-file patch.adx  0x500000 -s FUNC_TABLE 0x510000 -s FUNC_PATCH 0x510020
core0(gdb) set $pc=0x500000
core0(gdb) b main
Breakpoint 1 at 0x50010c: file ../main.c, line 20.
core0(gdb) c
Breakpoint 1, main () at ../main.c:20
20              printf("func1(30)=%dn",jump_table.func_a(30));
core0(gdb) s
func1 (x=30) at ../main.c:28
28              return x*num1;
core0(gdb) n
29      }
core0(gdb) s
main () at ../main.c:21
21              printf("func2(30)=%dn",jump_table.func_b(30));
core0(gdb) s
func2 (x=30) at ../patchprog.c:24
24              return x*num2*100;
core0(gdb)

上面過程中，先加載main的symbol，再加載patch的symbol及debug information。"add-symbol-file patch.adx  0x500000 -s FUNC_TABLE 0x510000 -s FUNC_PATCH 0x510020"是將patch section的symbol及debug information也載入gdb以debug。讀者可以在gdb里，打"help add-symbol-file"查閱add-symbol-file的用法。

3.1 主程序patch后的執行結果

func1(30)=30
func2(30)=6000
func3(30)=90

4. 結語

目前晶心科技使用GNU的toolchain，其功能非常強大。讀者可多動手試試不同的linker script寫法，使得開發firmware更有彈性及效率。