Tedd OKANO / Mbed 2 deprecated ika_shouyu_poppoyaki

this transfers data (which is stored in "bin" file in mbed storage) into LPC1114, LPC1115, LPC81x, LPC82x, LPC1768/LPC1769 and LPC11U68/LPC11E68 internal flash memory through ISP.

Dependencies:   mbed MODSERIAL DirectoryList

Information

日本語版がこのページ下半分にあります！

Japanese version is available lower half of this page.

Caution!

このプログラムでイカを焼くことはできません (^ ^;

"Ika-shouyu-poppoyaki" is a name of Japanese local food.
If I try to do a direct translation, it will be something like "Choo-choo grilled calamari with soy-sauce".
However, you may noticed already, it cannot be grilled by this program ;-)

ISP programming application on mbed

ISP program writes data into flash memory of target MCU.

This mbed program programs target MCU flash memory through UART. It uses "In-System Programming (ISP)" interface in target MCU (NXP LPC micro-controllers).

The ISP is done by PC with serial cable normally. The ISP protocol is executed software on a PC. The software reads a data file and transfers the data with the ISP protocol.
This program does same process of that. The mbed performs a function like "FlashMagic" or "lpc21isp".
(This program does not just copy the binary but also insert 4 byte checksum at address 0x1C.)

This program currently supports LPC1114, LPC1115, LPC81x, LPC82x, LPC1768/LPC1769 and LPC11U68/LPC11E68.

Information

For the LPC1768 and LPC1769, this program supports writing only. It cannot perform verifying.

Modification for targeting LPC82x series has been done by Mr. k4zuki. Thank you very much!
Modification for targeting LPC11U68/LPC11E68 has been done by HAPI- Tech. Thank you very much!!

/media/uploads/okano/copying_bin_e.png

How to execute

With this program, all you need to do is..

  1. Connect the mbed and the target (/RESET and /ISP_enable signals in are option. Those are not necessary if you set the target ISP mode manually)
  2. Rename your (binary) file to "bin" and copy into the mbed storage.
  3. Press reset button of mbed.
  • When the program completed successfully, you will find the LEDs on mbed blinks sequentially (LED1→LED2→LED3→LED4).
  • If it failed, the mbed reports it "Runtime error" by LEDs.
  • You can also monitor the progress and result on a terminal screen (mbed reports those by printf).
  • if you enabled "AUTO_PROGRAM_START", the program in the target will be started automatically.
  • from version 0.7, this program works as "USB-serial bridge" after the ISP writing done. The serial enabled target program (and if "AUTO_PROGRAM_START" is enabled, ) the UART will come up on the terminal screen after ISP completion. Please set "TARGET_OPERATION_BAUD_RATE" as baud rate of target program. The ISP speed can be set by "ISP_BAUD_RATE" separately.

/media/uploads/okano/files_in_storage_e.png

Information

If you don't have a file named "bin", the program will ask you which file you want to choose.
You will find a list of files on PC terminal and that interface let you select a file as source.
(The file names will appear in 8.3 format like old DOS.)

There are some options to bypassing the ISP to execute USB-serial through mode or erasing flash.

If there is a "bin" file, the program may work as usual.
(updated on 29-Jan-2015)

Sample of operation

Next picture is sample of the operation.

  1. The target (LPC1114) goes into ISP mode after first reset.
  2. mbed writes binary into flash in the target (binary size is 12668 bytes in this sample).
  3. when the writing completed, mbed starts reading the flash. the data is verified by comparing with original file.
  4. Asserting reset again with "ISP_enable pin" HIGH.
  5. The target starts to work with written binary (program). In this sample, the target sending character data on UART and toggling LED (GPIO) pin periodically.

/media/uploads/okano/isp_operation_sample_1114_e2.png

Recipe for adding chip support

Information

This section had been written by At_Zamasu_Zansu.
Thank you！

Describing how to add a target device.
Register new Device ID in target_table.cpp.

Targets defined in target_table.cpp.

target_table.cpp

target_param    target_table[]  = {
    { "unknown ttarget",        0xFFFFFFFF, 1024,    4096, 4096, UUENCODE, 0x10000200 },
    { "LPC1114FN28(FDH28)/102", 0x0A40902B, 4096,   32768, 4096, UUENCODE, 0x10000200 },
    { "LPC1114FN28(FDH28)/102", 0x1A40902B, 4096,   32768, 4096, UUENCODE, 0x10000200 },
    { "LPC810M021FN8",          0x00008100, 1024,    4096, 1024, BINARY,   0x10000300 },
    { "LPC811M001JDH16",        0x00008110, 2048,    8192, 1024, BINARY,   0x10000300 },
    { "LPC812M101JDH16",        0x00008120, 4096,   16384, 1024, BINARY,   0x10000300 },
    { "LPC812M101JD20",         0x00008121, 4096,   16384, 1024, BINARY,   0x10000300 },
    { "LPC812M101JDH20",        0x00008122, 4096,   16384, 1024, BINARY,   0x10000300 },
///added for LPC82x series
    { "LPC824M201JHI33",        0x00008241, 8192,   32768, 1024, BINARY,   0x10000300 },
    { "LPC822M101JHI33",        0x00008221, 4096,   16384, 1024, BINARY,   0x10000300 },
    { "LPC824M201JDH20",        0x00008242, 8192,   32768, 1024, BINARY,   0x10000300 },
    { "LPC822M101JDH20",        0x00008222, 4096,   16384, 1024, BINARY,   0x10000300 },
 
};

Structure of the table is defined in target_table.h.

target_table.h

typedef struct  taget_param_st {
    char            *type_name;
    int             id;
    int             ram_size;
    int             flash_size;
    int             sector_size;
    int             write_type;
    unsigned int    ram_start_address;
}

Items are defined in order of next sample in target_table.cpp

 {type_name, id, ram_size, flash_size, sector_size, write_type, ram_start_address}

Sample of how to do this

Data can be found in usermanual(UM) and datasheet. An example following.

In case of LPC82xx
UM10800 LPC82x User manual http://www.nxp.com/documents/user_manual/UM10800.pdf
LPC82x Product data sheet http://www.nxp.com/documents/data_sheet/LPC82X.pdf

  • type_name：
    • Table 322. Part identification numbers can be found by searching in UM. Pick up a device from the Table 322.
  • id:
    • Put a Hex coding value in Table 322.
  • ram_size:
    • Put target RAM size which can be found in datasheet by searching "Ordering options". Find the RAM size in Table2 (in bytes)
  • flash_size:
    • Put target flash size from the Table 2.
      The size should be calculated as "1KB = 1024" bytes.
  • sector_size:
    • A description of "The size of a sector is 1 KB and the size of a page is 64 Byte. One sector contains 16 pages" can be found in 25.5 General description, UM. Pick up taeget sector size and put it into the table in bytes. In this case, it will be 1024.
    • In case of LPC176x, the secotr size is 4KB for first 16 sectors and rest are 32K. So it cannot be defined by single value. For this type of targets, prepare a special value for the sector size. The program calculates the size when this value is detected.
  • ram_start_address：
    • Put an address of example which can be found by searching "UART ISP Write to RAM command" or "Write to RAM" in UM

Reference




イカ醤油ポッポ焼き

mbed用ISPプログラム

NXP製のマイコンは，内部フラッシュメモリへのプログラムの書き込みをUART経由で行うことができます．
通常，この作業はPC上のソフトウェア(たとえば"FlashMagic"や"lpc21isp"など)を用いて，PC上のファイルのデータを，UARTで接続したマイコンの内蔵フラッシュに書き込みます．

「イカ醤油ポッポ焼き」はmbedでそれらのソフトの代わりをさせるものです．mbedストレージ内に置いた「bin」と名付けられたファイルを読み，フラッシュへ書き込みます．
この書き込みを行う際には，アドレス0x1Cに置いておく必要のある4バイトのチェックサムも自動で追加されます．

現在サポートしているターゲットはLPC1114，LPC1115，LPC81x，LPC82x，LPC1768/LPC1769， LPC11U68/LPC11E68です．

Information

LPC1768 and LPC1769 では書き込みのみがサポートされます．読み出し検証は実行されません．

LPC82xシリーズをターゲットとするための変更をk4zukiさんがしてくださいました．ありがとうございます！
LPC11U68/LPC11E68をターゲットとするための変更をHAPI- Techさんがしてくださいました．ありがとうございます！

/media/uploads/okano/copying_bin_j.png

美味しい料理法

このプログラムの動かし方は次の通り

  1. mbedとターゲット(書き込み対象のマイコン)を接続する (ターゲットを手動でISPモードに入れる場合には，/RESET と /ISP_enable は接続する必要はありません)
  2. 書き込みたいファイル(バイナリフォーマット)の名前を「bin」に変更して，mbed内にコピー
  3. mbedのリセットボタンを押す
  • 書き込みが無事に終了するとmbed上のLEDが順番に点滅を繰り返します(LED1→LED2→LED3→LED4).
  • もし何らかのエラーが発生して失敗した場合には"Runtime error"が発生した時のLED点灯となります．
  • またコンピュータのターミナルで状況や結果を確認することもできます(mbedがprintfで状況を出力しています)
  • "AUTO_PROGRAM_START"を有効にしてあれば，書き込み終了後，ターゲットのプログラムは自動的にスタートします.
  • バージョン0.7以降，このプログラムはISP書き込みの終了後にUSB-Serialブリッジとして動作するようにしてあります．ターゲットのプログラムがシリアルを使うもので(かつ"AUTO_PROGRAM_START"が有効で)あれば，入出力はそのままISP完了後のターミナルに現れます．"TARGET_OPERATION_BAUD_RATE"はターゲットのプログラムが使うボーレートに合わせてください．ISPの書き込みに使うボーレートは "これとは別に"ISP_BAUD_RATE"で指定することができます.

/media/uploads/okano/files_in_storage_j2.png

Information

もし「bin」と名付けられたファイルが見つからなければ，(PCターミナル上で)どのファイルを選択するかが訊ねられます．
その表示を確認して，どのファイルを書き込むのかを選択してください．
「bin」ファイルが有れば，これまでと同じように動作します．(ファイル名はDOSのような8.3フォーマットで表示されます)

この他，ISPをバイパスしてシリアススルー・モードに行ったり，フラッシュを消すだけという操作も可能になっています．

(2015年1月29日にアップデートされました)

動作の例

次の図は動作の例です

  1. 最初のリセットによってターゲット(LPC1114)がISPモードに入ります
  2. mbedがターゲットのフラッシュにバイナリを書き込みます(この例では12668バイトのバイナリを書いています)
  3. 書き込みが終わるとフラッシュの読み出しを始めます．このデータを元のファイルとの比較し，検証を行います
  4. ISPイネーブル・ピンをHIGHにして再度リセットを行います
  5. ターゲットは書き込まれたプログラムの実行を開始します．この例ではターゲットは周期的にUARTへ文字データを送り，LEDを(GPIOピン)を点滅させます
  6. The target starts to work with written binary (program). The target sending character data on UART and toggling LED (GPIO) pin periodically.

/media/uploads/okano/isp_operation_sample_1114_j2.png


イカ醤油ポッポ焼き味付けレシピ

Information

この節はざますざんすさんが作成してくれました．
ありがとうございます！

これは，イカ醤油ポッポ焼きに新しいターゲットデバイスを追加する場合のレシピを纏めたものです．

必要事項：target_table.cpp へ新しいDevice ID register を追加する．

target_table.cppに記載されているターゲット一覧．

target_table.cpp

target_param    target_table[]  = {
    { "unknown ttarget",        0xFFFFFFFF, 1024,    4096, 4096, UUENCODE, 0x10000200 },
    { "LPC1114FN28(FDH28)/102", 0x0A40902B, 4096,   32768, 4096, UUENCODE, 0x10000200 },
    { "LPC1114FN28(FDH28)/102", 0x1A40902B, 4096,   32768, 4096, UUENCODE, 0x10000200 },
    { "LPC810M021FN8",          0x00008100, 1024,    4096, 1024, BINARY,   0x10000300 },
    { "LPC811M001JDH16",        0x00008110, 2048,    8192, 1024, BINARY,   0x10000300 },
    { "LPC812M101JDH16",        0x00008120, 4096,   16384, 1024, BINARY,   0x10000300 },
    { "LPC812M101JD20",         0x00008121, 4096,   16384, 1024, BINARY,   0x10000300 },
    { "LPC812M101JDH20",        0x00008122, 4096,   16384, 1024, BINARY,   0x10000300 },
///added for LPC82x series
    { "LPC824M201JHI33",        0x00008241, 8192,   32768, 1024, BINARY,   0x10000300 },
    { "LPC822M101JHI33",        0x00008221, 4096,   16384, 1024, BINARY,   0x10000300 },
    { "LPC824M201JDH20",        0x00008242, 8192,   32768, 1024, BINARY,   0x10000300 },
    { "LPC822M101JDH20",        0x00008222, 4096,   16384, 1024, BINARY,   0x10000300 },
 
};

上記コードは以下の構造を取っている．target_table.h に以下のコードがある．

target_table.h

typedef struct  taget_param_st {
    char            *type_name;
    int             id;
    int             ram_size;
    int             flash_size;
    int             sector_size;
    int             write_type;
    unsigned int    ram_start_address;
}

以下の順番にtarget_table.cppにコーディングする．

 {type_name, id, ram_size, flash_size, sector_size, write_type, ram_start_address}

作業の手順例

データはユーザマニュアル(UM)と Data sheet から検索する．以下に例を上げる．

LPC82xxの場合
UM10800 LPC82x User manual http://www.nxp.com/documents/user_manual/UM10800.pdf
LPC82x Product data sheet http://www.nxp.com/documents/data_sheet/LPC82X.pdf

  • type_name：
    • UMから Part identification numbers を検索すると，Table 322. Part identification numbersが現れる．Table 322より Table記載のDeviceを入力．
  • id:
    • UMから Part identification numbers を検索，Table 322. よりHex codingを入力．
  • ram_size:
    • Product data sheet よりOrdering options を検索しTable2より上記Deviceと同じターゲットのRAMサイズを記載(byte)
  • flash_size:
    • Product data sheet よりOrdering options を検索しTable2より上記Deviceと同じターゲットのFlashサイズを記載(byte)
      尚，1KBは1024byteにて計算
  • sector_size:
    • UMから Flash configuration を検索し25.5 General description に「The size of a sector is 1 KB and the size of a page is 64 Byte. One sector contains 16 pages.」と記載があるので，ターゲットのSectorサイズを記載（byte単位）．今回の場合は1KBなので1024byte．
    • LPC176xシリーズのセクタサイズは，最初の16セクタが4KB，残りを32KBとしているため一定の値では表せません．これに対応するため特別な値を用意して，プログラム内でその値を検出した際には実際の構成に則した計算を行うようにしています．
  • ram_start_address：
    • UMからUART ISP Write to RAM command もしくは Write to RAM を検索．Example に書いてあるアドレスを記載する．

参考

日本語版だけの(何の役にも立たない)参考情報

Information

何故このプログラムが作られたか．そして何故こんな名前なのか．
こちらを御覧ください →→ イカ醤油ポッポ焼きはイカにして生まれたか（´(ｪ)｀;

このプログラムを作ってみるきっかけになったツイート．

（´(ｪ)｀）

dir_handling/dir_handling.cpp

Committer:
okano
Date:
2015-01-29
Revision:
48:99cfe3a929ea
Child:
49:380e7be429ef

File content as of revision 48:99cfe3a929ea:

#include    "mbed.h"
#include    "dir_handling.h"
#include    "_user_settings.h"
#include    "DirectoryList.h"
#include    "isp.h"

#include    <iostream>
#include    <string>
#include    <cctype>
#include    <algorithm>

extern Serial      pc;
extern BusOut      leds;

void show_file_list( std::vector<std::string> list );
void user_action_waiting_indicator();


std::string get_file_name( std::string &default_path, const char *suffix )
{
    Ticker  led_blink;
    int     last_slash;

    last_slash  = (int)default_path.rfind( "/" );

    if ( last_slash == std::string::npos ) {
        default_path.clear();
        return ( default_path );
    }

    string file_name( default_path.c_str() + last_slash + 1 );
    string path_name( default_path.c_str(), default_path.c_str() + last_slash );

    //printf( "path_name : %s\r\n", path_name.c_str() );
    //printf( "file_name : %s\r\n", file_name.c_str() );

    file_name.push_back( '.' );
    std::transform( file_name.begin(), file_name.end(), file_name.begin(), toupper );

    DirectoryList               dir( path_name );
    std::vector<std::string>    list;

    for ( int i = 0; i < dir.size(); i++ ) {
        if ( dir[ i ] == file_name ) {
            return ( default_path );
        }

        if ( *suffix == '*' ) {
            list    = dir;
        } else {
            //printf( "-- [%s][%d]\r\n", dir[ i ].c_str(), dir[ i ].find( ".BIN" ) );
            //if ( (8 == dir[ i ].find( ".BIN" )) && (0 != dir[ i ].find( "IKA" )) ) {
            if ( (9 == dir[ i ].find( suffix )) ) {
                list.push_back( dir[ i ] );
            }
        }
    }

    led_blink.attach( &user_action_waiting_indicator, 0.05 );

    printf( "\r\n  WARNING : No file which has name of \"%s\" was found.\r\n", default_path.c_str() );
    printf( "  now showing \"%s\" directory to select a source file.\r\n\r\n", path_name.c_str() );

    if ( !list.size() ) {
        printf( "  WARNING : No file which has suffix of \"%s\" was found.\r\n", suffix );
        default_path.clear();
        return ( default_path );
    }

#define FORMAT_FOR_SELECTED_FILE_NAME   "    selected file : [%3d] : \"%-12s\"            \r"

    //printf( "  ==== directory by \"%s/*.%s\" (excluding \"%s/ika*.bin\") ====\r\n", path_name.c_str(), suffix, path_name.c_str() );
    printf( "  ==== directory by \"%s/*.%s\", %d files ====\r\n", path_name.c_str(), suffix, list.size() );

    show_file_list( list );

    int     done    = false;
    int     index   = 0;
    int     c;

    printf( FORMAT_FOR_SELECTED_FILE_NAME, index, list[ index ].c_str() );
    fflush( stdout );

    while ( !done ) {
        if ( pc.readable() ) {
            switch ( c  = pc.getc() ) {
                case '\r' :
                case '\n' :
                    done    = true;
                    break;

                case 'e' :
                case 'E' :
                    printf( "\r\n  Erasing the flash memory\r\n" );
                    default_path    = "\xFF";
                    return ( default_path );
                    //break;

                case 'a' :
                case 'A' :
                case 'c' :
                case 'C' :
                    printf( "\r\n  Aborted to cancel the ISP execution\r\n" );
                    default_path.clear();
                    return ( default_path );
                    //break;

                case '0' :
                case '1' :
                case '2' :
                case '3' :
                case '4' :
                case '5' :
                case '6' :
                case '7' :
                case '8' :
                case '9' :
                    index   = c - '0';
                    index   = ( (list.size() - 1) < index ) ? (list.size() - 1) : index;
                    break;
                case '?' :
                    show_file_list( list );
                    break;


                case 0x1B :
                    if ( 0x5B == pc.getc() )
                        //  arrow key pressed
                        switch ( c  = pc.getc() ) {
                            case 0x41 :
                            case 0x43 :
                                index   += ( index == (list.size() - 1) ) ? 0 : 1;
                                break;
                            case 0x42 :
                            case 0x44 :
                                index   -= ( index == 0 ) ? 0 : 1;
                                break;
                            default :
                                break;
                        }
            }

            printf( FORMAT_FOR_SELECTED_FILE_NAME, index, list[ index ].c_str() );
            fflush( stdout );
        }
    }

    default_path.clear();
    default_path    = path_name + "/" + list[ index ];

    printf( "\r\n    flash writing source file : \"%s\"\r\n\r\n", default_path.c_str() );

    return ( default_path );
}

void show_file_list( std::vector<std::string> list )
{
    int width;
    int height;
    int d_i;

    width   = (list.size() / 5) + 1;
    width   = (4 < width) ? 4 : width;
    height  = (list.size() + (width - 1)) / width;

    for ( int i = 0; i < height; i++ ) {
        for ( int j = 0; j < width; j++ ) {

            d_i     = i + j * height;

            if ( list.size() <= d_i )
                break;

            printf( "  %3d : %-12s", d_i, list[ d_i ].c_str() );
        }
        printf( "\r\n" );
    }
    printf( "\r\n" );
    printf( "  ** Use arrow key (up/down or left/right) to select a file\r\n" );
    printf( "  ** or ..\r\n" );
    printf( "  **   press [a] key for abort and go to serial through mode\r\n" );
    printf( "  **   press [e] key for erasing flash\r\n" );
    printf( "  **   press [?] key to display this message again\r\n\r\n" );
}


void user_action_waiting_indicator()
{
    static int  i   = 0;

    if ( (i == 0) || (i == 3) )
        leds    = 0xF;
    else
        leds    = 0x0;

    i++;
    i   &= 0xF;
}