LPC810メモ:I2C-bus ROM API、I2C slaveとして動作させる(LPC810 2個使ってmaster-slave通信)

I2C-bus ROM APIを利用して、I2Cのslaveとして動作させる例。

LPC810を2個使って、それぞれmaster/slaveとして機能させ、masterからslaveに文字列を送信する。LPC810が2個必要だが、他の種類のマイコンを持ってない人でも試せるので、自分のように「LPC810から始めました」な人にとっては良い例を作れたのではないかと思う。そんな人が他に居るか知らないが。

プログラム自体はmaster側としてもslave側としても機能するもので、バイナリサイズは1608byte、まあまあ小さいのではないかと思われる。なお、master送信、slave受信のみ。逆は次に試したい。

前提とする環境はこちら→LPC810メモ共通の準備
masterとして送信するだけのサンプルはこちら(今思えばこれは簡単だった)→http://d.hatena.ne.jp/mikkabo/20150401/1427899147

1byte受信や、固定長の受信まではわりと楽勝だった。でも「stopコンディションになるまで読む」を実現するのにかなり苦労したというか、I2C-bus ROM API、i2c_slave_receive_intr関数の挙動がバグじゃないかと疑うくらい不思議。最後の「補足/雑感」のところで疑問をぶちまけるので、詳しかったりベテランの親切な方が偶然ここを読んでくれていたら、ぜひご教示をいただきたいですm(_ _)m

LPC810を2個使う。
- 1つはmaster、もう片方はslave。
- プログラムは共通。開始直後に8番pinの入力を読み込み、LOWならmaster、HIGHならslaveとして動作する仕組み。
master側の8番にプッシュボタンをつけておいて、HIGH、LOWの状態に応じてslave側にI2Cで送信
- HIGHなら"led on"という文字列を送信しつつ、自分の2番pinをHIGH(LED点灯)
- LOWなら"led off"という文字列を送信しつつ、自分の2番pinをLOW(LED消灯)
- 文字列である必然性は全くないが、複数byte通信しないと面白くないので、あえて文字列。
slave側は、"led on"を受信したら2番pinをHIGH(LED点灯)、"led off"を受信したら2番pinをLOW(LED消灯)
結果として、master側のプッシュボタンを押す/離すことにより、master,slave両方のLEDが点灯/消灯することになる。

サンプルコード

コメントで「★」マークがついている部分は、I2C-bus ROM APIの不思議な挙動を回避しようと書いたコード。
何が不思議と思っているかは、最後の「補足/雑感」のところに記載。

#include "LPC8xx.h"
#include<string.h>

#define I2C_BUFF_SZ         16

// UM10601 24.4 API description
// に相当すると思われるプロトタイプ宣言を、
// LPCOpenのヘッダから持ってきた。
extern "C" {
    typedef int ErrorCode_t; // 本当はenumだけど今回は値は見ない
    typedef int CHIP_I2C_MODE_T; // これも本当はenum
    typedef void *I2C_HANDLE_T;
    typedef void (*I2C_CALLBK_T)(uint32_t err_code, uint32_t n);

    typedef struct I2C_PARAM {
        uint32_t        num_bytes_send;
        uint32_t        num_bytes_rec;
        uint8_t         *buffer_ptr_send;
        uint8_t         *buffer_ptr_rec;
        I2C_CALLBK_T    func_pt;
        uint8_t         stop_flag;
        uint8_t         dummy[3];
    } I2C_PARAM_T;

    typedef struct I2C_RESULT {
        uint32_t n_bytes_sent;
        uint32_t n_bytes_recd;
    } I2C_RESULT_T;

    typedef struct  I2CD_API {
        void (*i2c_isr_handler)(I2C_HANDLE_T *handle);
        ErrorCode_t (*i2c_master_transmit_poll)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_master_receive_poll)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_master_tx_rx_poll)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_master_transmit_intr)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_master_receive_intr)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_master_tx_rx_intr)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_slave_receive_poll)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_slave_transmit_poll)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_slave_receive_intr)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_slave_transmit_intr)(I2C_HANDLE_T *handle, I2C_PARAM_T *param, I2C_RESULT_T *result);
        ErrorCode_t (*i2c_set_slave_addr)(I2C_HANDLE_T *handle, uint32_t slave_addr_0_3, uint32_t slave_mask_0_3);
        uint32_t        (*i2c_get_mem_size)(void);
        I2C_HANDLE_T *  (*i2c_setup)( uint32_t  i2c_base_addr, uint32_t * start_of_ram);
        ErrorCode_t     (*i2c_set_bitrate)(I2C_HANDLE_T *handle, uint32_t  p_clk_in_hz, uint32_t bitrate_in_bps);
        uint32_t        (*i2c_get_firmware_version)(void);
        CHIP_I2C_MODE_T (*i2c_get_status)(I2C_HANDLE_T *handle);
        ErrorCode_t     (*i2c_set_timeout)(I2C_HANDLE_T *handle, uint32_t timeout);
    } I2CD_API_T;

    // 「UM10601 21.5.2 ROM-based APIs」に相当するstruct
    // 本当はI2C以外も定義されているが今回は省略
    typedef struct ROM_API {
        const uint32_t    dummy1[5];
        const I2CD_API_T  *pI2CD;
        const uint32_t    dummy2[4];
    } LPC_ROM_API_T;

// UM10601 24.3 General description
// より、アドレスの設定
#define LPC_I2CD_API ((*(LPC_ROM_API_T * *) 0x1FFF1FF8UL)->pI2CD)
}

// master側の記述ここから
//  APIを使う前提となる変数を用意
static I2C_HANDLE_T *i2cHandleMaster;
static uint32_t i2cMasterHandleMEM[0x20];

// num byteのデータを送信
static void masterSendData(uint8_t addr, uint8_t data[], uint32_t num)
{
    uint8_t d[I2C_BUFF_SZ];
    d[0] = addr; // 0byte目はslaveのアドレスを入れる
    memcpy(&d[1], data, num); // [1]から先がデータ本体
    I2C_PARAM_T param;
    I2C_RESULT_T result;

    param.num_bytes_send  = num + 1; // addrの分を含めてnum + 1 byte送信
    param.buffer_ptr_send  = &d[0];
    param.num_bytes_rec  = 0; // 受信はしない(byte)
    param.stop_flag   = 1; // 送信終わったらstop

    // タイムアウト設定
    // UM10601 24.4.18 I2C time-out value
    LPC_I2CD_API->i2c_set_timeout(i2cHandleMaster, 100000);

    // 送信
    // UM10601 24.4.2 I2C Master Transmit Polling
    LPC_I2CD_API->i2c_master_transmit_poll(i2cHandleMaster, &param, &result);
}

// master側の初期設定
static void masterMain() {
    //  I2C-bus ROM APIを使って初期設定
    // UM10601 24.4.14 I2C Setup
    i2cHandleMaster = LPC_I2CD_API->i2c_setup(LPC_I2C_BASE, i2cMasterHandleMEM);

    // UM10601 24.4.15 I2C Set Bit Rate
    LPC_I2CD_API->i2c_set_bitrate(i2cHandleMaster, 12000000, 100000); // 速度100KHz

    while(1) {

        if(LPC_GPIO_PORT->PIN0 & (1<<0)) { 
            // 8番pinがHIGH
            // address 0xc0の slaveに文字列"led on"を送信
            uint8_t data[] = "led on";
            masterSendData(0xc0, data, sizeof(data));

            //  2番pinをHIGHに(master側のledを点灯)
            LPC_GPIO_PORT->SET0 |= (1 << 4);
        } else {
            // 8番pinがHIGH
            // address 0xc0 のslaveに文字列"led off"を送信
            uint8_t data[] = "led off";
            masterSendData(0xc0, data, sizeof(data));

            //  2番pinをLOWに(master側のledを消灯)
            LPC_GPIO_PORT->CLR0 |= (1 << 4);
        }

        //  適当にwait
        for(volatile int i = 0; i < 200000; i++) {}
    }
}
// master側の記述ここまで

// slave側の記述ここから
//  APIを使う前提となる変数を用意
static I2C_HANDLE_T *i2cHandleSlave;
static uint32_t i2cSlaveHandleMEM[0x20];

// 受信用のバッファ
static uint8_t rxBuff[I2C_BUFF_SZ];

// 割り込みを使う都合上、APIで使うパラメータをファイルスコープで用意
static I2C_PARAM_T slaveParam;
static I2C_RESULT_T slaveResult;

// ★何文字読んだか、rom apiの外側で記録するカウンタ
static uint32_t slaveRecvCounter = 0;

// 受信の準備
// 最初の1回だけは、slaveのアドレスとコールバックを設定して呼び出すようにした。
static void slaveSetupRecv(uint8_t addr = 0, I2C_CALLBK_T  func = 0) {
    if(addr != 0) {
        // slaveのアドレスを設定
        // UM10601 24.4.12 I2C Set Slave Address
        LPC_I2CD_API->i2c_set_slave_addr(i2cHandleSlave, addr, 0);
    }

    // コールバック関数を設定
    if(func != 0) { slaveParam.func_pt = func;   }

    // 受信用のバッファを設定
    slaveParam.buffer_ptr_rec = rxBuff;

    // 最大受信バイト数
    slaveParam.num_bytes_rec = sizeof(rxBuff);

    // 読み込んだ文字数をリセット
    slaveResult.n_bytes_recd = 0;
    slaveRecvCounter = 0; // ★読み込んだ文字数を、rom apiの外側でも記録

    // ★なぜかrom apiが使わない、Slave Deselectの割り込みを有効化
    // 16.6.3 Interrupt Enable Set and read register
    LPC_I2C->INTENSET |= (1 << 15); 

    // i2c slaveの受信、割り込みモード
    // 完了したらコールバックが呼ばれる仕組み
    // UM10601 24.4.10 I2C Slave Receive Interrupt
    LPC_I2CD_API->i2c_slave_receive_intr(i2cHandleSlave, &slaveParam, &slaveResult);
}

// 受信完了時に呼ばれるコールバック
static void slaveCompleteRecv(uint32_t err_code, uint32_t n) {
    static char buffer[I2C_BUFF_SZ];

    if (slaveResult.n_bytes_recd > 1) {
        // 1byteより多く読み込まれた場合
        // なお、0byte目はslave addressが入るので、1byteジャストだと
        // 実質読み込まれてない。

        // slave addressを除いたrxBuff[1] 以降を取り出す
        strncpy(buffer, (char *)(&rxBuff[1]), sizeof(buffer)); 
        buffer[sizeof(buffer) - 1] = 0; // null終端の保証

        // masterから送信された文字列が・・・
        if(strcmp(buffer, "led on") == 0) {
            // "led on"なら、2番pinをHIGHに(slave側のledを点灯)
            LPC_GPIO_PORT->SET0 |= (1 << 4);
        } else if(strcmp(buffer, "led off") == 0) {
            // "led on"なら、2番pinをLOWに(slave側のledを点灯)
            LPC_GPIO_PORT->CLR0 |= (1 << 4);
        }
    }

    // 次回の受信準備
    slaveSetupRecv();
}

// I2C割り込みハンドラ
extern "C" {
    void I2C_IRQHandler(void)
    {
        // ★slave pending状態で、slave receive.の場合、読み込み文字数を1増やす
        // UM10601 16.6.7 I2C Interrupt Status register
        // UM10601 16.6.2 I2C Status register
        if(
           (LPC_I2C->INTSTAT & (1 << 8)) && 
           ((LPC_I2C->STAT & (0x3 << 9)) == (0x1 << 9))) {
            slaveRecvCounter++;
        }

        // 処理をrom apiに委譲
        LPC_I2CD_API->i2c_isr_handler(i2cHandleSlave);

        // ★Slave Deselectedの割り込みを処理
        // UM10601 16.6.7 I2C Interrupt Status register
        if(LPC_I2C->INTSTAT & (1 << 15)) {
            if(slaveRecvCounter > 0) {
                // ★1byte以上読み込んでいたら、rom apiに代わってコールバック関数を呼ぶ
                slaveResult.n_bytes_recd = slaveRecvCounter;
                slaveCompleteRecv(0,0);
            }
            LPC_I2C->STAT |= (1 << 15);
        }
    }
}

static void slaveMain() {
    //  I2C-bus ROM APIを使って初期設定
    // UM10601 24.4.14 I2C Setup
    i2cHandleSlave =LPC_I2CD_API->i2c_setup(LPC_I2C_BASE, i2cSlaveHandleMEM);

    // タイムアウト設定
    // UM10601 24.4.18 I2C time-out value
    LPC_I2CD_API->i2c_set_timeout(i2cHandleSlave, 100000);

    //  Enable/disable the I2C interrupt in interrupt slots #8 in the NVIC.
    NVIC->ISER[0] = (0x1 << 8);

    // 受信の準備
    slaveSetupRecv(0xc0, slaveCompleteRecv);
}
// slave側の記述ここまで

int main(void) {
    // SWMのclockを有効化。
    // UM10601 4.6.13 System clock control register
    // → SWMは7bit目
    LPC_SYSCON->SYSAHBCLKCTRL |= (1<<7);

    // SDAを4番pinに
    // UM10601  9.5.8 Pin assign register 7
    LPC_SWM->PINASSIGN7 = 0x02ffffffUL;

    // SCLを3番pinに
    // UM10601  9.5.9 Pin assign register 8
    LPC_SWM->PINASSIGN8 = 0xffffff03UL;

    // fixed pin functionはreset以外全部disable
    // UM10601  9.5.10 Pin enable register 0
    LPC_SWM->PINENABLE0 = 0xffffffbfUL;

    // UM10601  16.3 Basic configuration
    // にしたがってI2Cの準備
    // In the SYSAHBCLKCTRL register, set bit 5 (Table 30) to enable the clock to theregister interface.
    LPC_SYSCON->SYSAHBCLKCTRL |= (0x1<<5);

    // Clear the I2C peripheral reset using the PRESETCTRL register (Table 19).
    LPC_SYSCON->PRESETCTRL &= ~(0x1<<6);
    LPC_SYSCON->PRESETCTRL |= (0x1<<6);

    // GPIO clockを有効化
    // UM10601 4.6.13 System clock control register
    LPC_SYSCON->SYSAHBCLKCTRL |= (1<<6);

    // 2番pinを出力に設定
    LPC_GPIO_PORT->DIR0 |= (1<<4);

    if(LPC_GPIO_PORT->PIN0 & (1<<0)) {
        // 開始時点で8番がHIGH -> slaveとして動作
        slaveMain();
    } else {
        // 開始時点で8番がLOW -> masterとして動作
        masterMain();
    }
    return 0 ;
}

接続

上のLPC810がmaster、下がslave。
- 下は8番pinが常にHIGHになっているので、前述のプログラムより、slaveとして動作する。
I2Cは、3番pinがSCL、4番pinがSDA。pull up抵抗は適当に3KΩ。
LEDは写真ではわかりにくいが、2番pinについてる。
masterの8番についてるボタンを押すと、master,slaveの両方のLEDが点灯、離すと消灯。

補足/雑感

実は、I2C-bus ROM APIがコールバックを呼んでくれず、結構苦労した。疑問に思うことを書くので、親切な方が偶然ここを読んでくれていたら、ぜひご教示をいただきたい。

1byte受信や、固定長の受信は簡単だった。サンプルコードのslaveParam.num_bytes_recのところに、たとえば3を代入しておけば、3byte受信した時点でコールバック(上記例だとslaveCompleteRecv)が呼ばれる。ところがその場合、masterから2byteだけ送信してstopコンディションで打ち切った場合、コールバックが呼ばれない。

まず、i2c_slave_receive_intrが固定長の受信にしか対応しないのではないかと思った。しかし、UM10601「24.5.5 I2C Slave Mode Transmit/Receive」を見ると、「STOP or repeated START is received」まで受信する、って書いてあるのでおかしい。

それでも「i2c_slave_receive_intrはSTOP conditionを検知しない」というのが現時点での自分の見解であり、なぜそうなのかが非常に疑問。そう思う理由は下記なので、考え方が間違っていたら教えてほしい。

stop conditionが検知されたら、Slave Deselectの割り込みが発生するはず。
- 根拠。UM10601「16.6.2 I2C Status register」→SLVDESEL
Slave Deselectの割り込みを使うつもりなら、INTENSETレジスタで対応するbitが立ってるはずだ。
- 根拠。UM10601「16.6.3 Interrupt Enable Set and read register」→SLVDESELEN
i2c_slave_receive_intrをコール後に、INTENSETレジスタでどのbitが立ってるか確かめてみた。結果は以下のとおり。
- 8:SLVPENDINGEN
- 24:EVENTTIMEOUTEN
- 25:SCLTIMEOUTEN
すなわち、timeoutを除くと、slave pendingの割り込み以外は処理する気がないようだ。15:SLVDESELENは無視される。
上記より、i2c_slave_receive_intrはSTOP conditionを検知しない

このように思ったので、サンプルではSLVDESELENを立てて、検知したら勝手にcallbackを呼ぶようにしてみた。一応ちゃんと動いている模様。

さらに補足。

上での述べたが、固定長であればslaveParam.num_bytes_recを受信するbyte数(正確にはaddressの1byteをプラスするので、受信するbyte数+1)にすれば良いので、サンプルコードの「★」マークのような余計なコードは省略できる。
stopコンディション検知前でも、受信したデータはslaveParam.buffer_ptr_recに順次格納される。
しかし、読み込んだbyte数であるslaveResult.n_bytes_recdは、最後に設定されるらしい。1byte毎にインクリメントされたりはしない。従って、サンプルのようにcallbackを無理やり呼び出す仕組みだと何文字読まれたかはわからない。
- サンプルで、ROM APIの外で、slaveRecvCounterなどという変数を用意してカウントしているのはそのため。
苦労した分楽しかった。LPC810をたくさん並べて動かすとか、夢が広がる。2個しか買ってないのが残念、でも逆に考えると、2個買っておいてよかった。
この後、master受信/slave送信も成功させたら、クラス化したいところ。

みっかぼの無料Androidアプリはこちら。