EEPROM ライブラリで使用している pfdl.a 不具合報告

GR-KURUMI の EEPROM ライブラリは pfdl.a という謎のライブラリをリンクし内部で使用しています。

ライブラリ本体の pfdl.a とヘッダファイルの pfdl.h と pfdl_types.h が標準のテンプレートに含まれるため EEPROM ライブラリを使用しなくとも pfdl.a が使用できそうですが、不具合、あるいは改善すべき点がみつかったので報告いたします。

ヘッダファイルの pfdl.h と pfdl_types.h は C++ のプログラムからインクルードされることを考慮されていないため、C++ のプログラムから利用するためには

extern "C" {
#include <pfdl.h>
#include <pfdl_types.h>
}

とする必要があります。

pfdl.a のバージョン文字列を取得(?)する PFDL_GetVersionString() という関数は

/*GR-KURUMI Sketch Template Version: V2.01*/
#include <Arduino.h>
extern "C" {
#include <pfdl.h>
#include <pfdl_types.h>
}

void setup()
{
    Serial.begin(9600);
    pfdl_u08* version = PFDL_GetVersionString();
    Serial.println((uint16_t)version, HEX);
    Serial.println((const char*)version);
}

void loop()
{
}

等とすれば利用できます。 

2行目が文字列で、1行目がそのアドレスということであり、ビルドの際に生成された .map ファイルを確認すると

 *(PFDL_COD)
 PFDL_COD       0x000085a6       0x1c ./gr_common/libraries/EEPROM/utility/pfdl.a(pfdl_version.o)
                0x000085a6                PFDL_GetVersionString
                0x000085a6                PFDL_GetVersionString
                0x000085af                PFDL_VERSION_STRING

文字列と関数の両方が PFDL_COD というセクションに配置されていることがわかります。

PFDL_GetVersionString() の関数プロトタイプ宣言は pfdl.h で定義されており

extern  pfdl_u08* PFDL_GetVersionString(void)  __attribute__ ((section ("PFDL_COD")));

となっていますが、PFDL_GetVersionString() の機能が ROM に配置された PFDL_VERSION_STRING のアドレスを返すのであれば

extern  const pfdl_u08* PFDL_GetVersionString(void)  __attribute__ ((section ("PFDL_COD")));

となっているべきです。

PFDL_COD セクションは gr_common/rl78_R5F100GJAFB.ld では

  .text           :
  {
    PROVIDE (_start = .);
    *(.text P .stub .text.* .gnu.linkonce.t.*)
    *(PFDL_COD)
    ; KEEP(*reset_program.o(.text))
    KEEP (*(.text.*personality*))
    /* .gnu.warning sections are handled specially by elf32.em.  */
    *(.gnu.warning)
    *(.interp .hash .dynsym .dynstr .gnu.version*)
    PROVIDE (__etext = .);
    PROVIDE (_etext = .);
    PROVIDE (etext = .);
    . = ALIGN(2);
    KEEP (*(.init))
    KEEP (*(.fini))
  } > ROM

と定義されており、.text セクションの次に配置されるようなっていますが、.text セクションの次ではリンクした際に RL78/G13 の Mirror 領域に配置される保証がなく、.text セクションがある程度の大きさになった場合、PFDL_COD セクションが Mirror 領域を超えて PFDL_GetVersionString() で取得した文字列 PFDL_VERSION_STRING が参照できなくなります。

/*GR-KURUMI Sketch Template Version: V2.01*/
#include <Arduino.h>
extern "C" {
#include <pfdl.h>
#include <pfdl_types.h>
}

void setup()
{
    Serial.begin(9600);
    pfdl_u08* version = PFDL_GetVersionString();
    Serial.println((uint16_t)version, HEX);
    Serial.println((const char*)version);
}

void loop()
{
    __asm __volatile(
        "    .rept 0x3000\n"
        "        nop\n"
        "    .endr\n"
    );
}

PFDL_VERSION_STRING は Mirror 領域に配置される標準の .rodata セクションか、あるいは別名の Mirror 領域に配置されるセクションに配置するべきでしょう。

pfdl.a に含まれる関数のコードは PFDL_COD セクションに配置されていますが、これも同様に .text セクションか、別名のセクションに配置するべきでしょう。現状の pfdl.a のまゝ PFDL_COD セクション全体を Mirror 領域に配置する方法も考えられますが、Mirror 領域で参照できる ROM の領域は容量全体の一部でしかなく、そこにコードを配置するのは勿体ないことです。文字列とコードはセクションを別にするべきです。

まとめると

• ヘッダファイルは C++ に対応するべき
• PFDL_GetVersionString() の関数プロトタイプ宣言を修正するべき
• PFDL_GetVersionString() が返す文字列は Mirror 領域に配置するべき
• pfdl.a で提供される関数のコードは .text セクション等に配置するべき

以上です。