NXP JN516X (TWELITE) をプログラミングする（OTA Update)

無線が使えるとなると無性に無線でファームウェア更新がしたくなってくる。所謂ＯＴＡというやつだ。なので頑張って作ってみようとしたもののハマリどころ満載でメチャ時間がかかってしまった。(-_-;)

有線ならエラーなど発生することはあまりないが無線というのは同じ周波数帯を使う他の電子機器等の電波干渉に加え設置場所付近の障害物による電波の乱反射等により通信が不安定になったりするものだ。車庫などの狭い空間に自家用車があったりするとその駐車位置により通信できなくなったりすることもある。

例えばＡデバイスからＢデバイスに送信したときＢデバイスが受信できなかった、或いは、Ｂデバイスは受信し結果を送信したのにＡデバイスが受信できなかったという２つの事象が発生してしまうのが厄介だ。つまり受信できなかったのはどちらなのかががわからないため単純なリトライだけでは解決できないことがある。これを解決するには重複パケットの除去処理に加え送信の再送処理が必要となる。しかも通信相手が複数ある場合はその複数の相手毎に管理が必要だ。送信側は送信処理中に再送することは簡単ではあるが受信側は受信パケット処理後はメイン処理に戻ってしまうため処理結果の再送は少し面倒だ。しかも、複数の相手と通信してる場合はさらに厄介なことになる。ということを踏まえたうえで完璧とは言えないが最善と思われるロジックを考えてみた。

送信先デバイス毎に管理されるカウントアップカウンターを含むパケットを送信し受信したデバイスは送信元デバイス毎に管理するカウンターと違うなら新たなパケットとして処理を行い同じならリトライパケットと見なし直前の送信データがあれば再送する。送信デバイス側は送信後のレスポンスが受信できなければ前回と同じカウンター値で再送処理を行うというだけだ。これだけでどちら側が受信できなかったかにかかわらず確実な再送処理が可能となる。

【通信中のOTA-BRIDGE(MONOSTICK)】
※赤点滅は通信中。途中で通信が途切れても再送処理により復旧している。リトライは５回まで行うが１回目でほぼ復旧できるようだ。

ＯＴＡというとＥＳＰ３２などのように２分割したフラッシュ領域を交互に切り替えるのが一般的らしい。JN5169/JN5179であればフラッシュ領域が512Kbあるので問題ないがJN5164は160Kbしかないので単純に分割するとアプリ領域が不足してしまう。なので最初はJN5169でないと無理かなと思っていたがJN5164になんとか対応できる方法はないものかと思案してみたところある方法を思いついた。JN516xシリーズのフラッシュは32Kbのセクターに分割されていて各セクターは自由に論理アドレス空間にマッピングすることができ複数のアプリを書き込むことも可能となっている。ブートローダーはフラッシュの先頭から順に各セクターを検索し最初に発見した有効なアプリを起動するようになっているのでＯＴＡブートローダーを最終セクターに書き込んでおいてＯＴＡアップデートを開始するときにアプリを起動できないようにしてから再起動するとＯＴＡブートローダーを起動することができる。この方法であればＯＴＡブートローダーが占有するセクター以外をアプリ領域とすることができる。ということで可能な限り小さいＯＴＡブートローダーを作ってみたところ１セクターにギリギリ収まってしまった。これなら１セクター(32Kb)だけアプリ領域が少なくなるだけなのでJN5164にも対応することが可能だ。但し、アプリは簡単に100Kbを超えてしまうためJN5164では余裕があまりない．．．

で、実際にアプリの書き換えを試してみると誤動作してしまう。なぜなのかわからなくて調査に時間がかかってしまったがSDKのFlash-APIの引数で指定するセクター番号やアドレスは物理アドレスではなくマッピング後の論理アドレスであることがわかった。このことはドキュメントのどこにも書かれていないし、ブートローダーのマッピングの仕方が少しヘンというかアプリ領域以外の空きセクターが順不同でマッピングされてしまう。最悪はマッピングされないセクターもあったりするようなので目的のセクターにアクセスするには自分で再マッピングしたほうが賢明だ。それらのことを知らないとSDKのFlash-APIは使いものにならないだろう。

ＯＴＡブートローダーの機能はWPanクラスに組み込んである。なのでアプリは自動的にＯＴＡ対応になる。アプリで何か特別なことを行う必要もなく単にWPan::begin()を呼び出しWPanクラスを開始するだけでＯＫだ。またＯＴＡブートローダーアプリ(最小サイズのＯＴＡアプリ)もＯＴＡで書き込めるようにしてみた。最初の書き込みにはプログラマーが必要であるが一度ＯＴＡ対応アブリを書き込めばいつでもＯＴＡアップデート可能となる。但し、アプリのアップデートに先立ち一度だけＯＴＡブートローダーアプリの書き込みが必要となる。前もって書き込んでおくことも可能だが前投稿で紹介したプログラマーを使う必要がある。他社のプログラマーは一つのアプリしか書けないので使用できない。

【接続図】
PC(JN516X-OTA.exe)<--USB-->MONOSTICK(OTA-BRIDGE.bin)<--Wireless-->JN516X(OTA-BOOT.bin)

【使い方】

１．setup()にてWPan::begin(0)を実行するアプリ(userapp.bin)を作成し書き込んだデバイスを起動しておく。

　　※動作確認用にＬチカ・アプリなどが最適。

２．OTA-BRIDGE.binを書き込んだデバイスをUSB接続する。

　　※TWELITE-R(2)/MONISTICK(推奨)が必要。

３．USB接続先の番号を調べる

　　例:JN516X-OTA.exe -s

４．USB接続先の番号、ターゲットデバイスの無線アドレスとOTA-BOOT.binファイルを指定して実行する。(一度だけでＯＫ)

　　例:JN516X-OTA.exe -p 2 -a 0 -w JN5164-MWSDK-OTA-BOOT.bin

５．USB接続先の番号、ターゲットデバイスの無線アドレスと書き込むuserapp.binファイルを指定して実行する。

　　例:JN516X-OTA.exe -p 2 -a 0 -w userapp.bin

６．途中でエラー時はアドレスに65534を指定し再実行する。(稀にある)

　　例:JN516X-OTA.exe -p 2 -a 65534 -w userapp.bin

【修正履歴】
2022-06-01
JN5164で作成したプログラムが書き込みできなくて調べてみたらチップがJN5168だった。JN5161/JN5164/JN5168は同一パイナリーで動作するのでJN5161/JN5164/JN5168については同一チップと見なすように変更した。

【ダウンロード(eclipseプロジェクト)】

JN516X-OTA-eclipse
JN5164-MWSDK-OTA-BOOT-eclipse
JN5164-MWSDK-OTA-BRIDGE-eclipse
JN5169-MWSDK-OTA-BOOT-eclipse
JN5169-MWSDK-OTA-BRIDGE-eclipse

【OTA Update Utility】

/*
 main.cpp - OTA Update Utility for NXP JN516x Series

 Copyright (c) 2022 Sasapea's Lab. All right reserved.

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2.1 of the License, or (at your option) any later version.

 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General
 Public License along with this library; if not, write to the
 Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 Boston, MA  02111-1307  USA
 */
#include <stdio.h>
#include <stdint.h>
#include <stdbool.h>
#include "jn516x_ota.h"

class Device : public JN516x_OTA
{
  public:

    Device(void) {}
    virtual ~Device(void) {}

  protected:

    void programStart(const char *chipname, const char *filename, bool program) override
    {
      if (program)
        printf("Write Device [%s] <- \"%s\"\n", chipname, filename);
      else
        printf("Read Device [%s] -> \"%s\"\n", chipname, filename);
    }

    void programProgress(size_t size, size_t processed) override
    {
      printf("Progress: %6llu/%6llu\r", processed, size);
    }

    void programEnd(STATUS status) override
    {
      if (status == STATUS_OK)
        printf("\nSuccess.\n");
      else if (status == STATUS_INVALID_DEVICE)
        printf("\nError: Not Supported Device\n");
      else if (status == STATUS_INVALID_FILE)
        printf("\nError: Other device binaries (.bin)\n");
      else
        printf("\nError: 0x%02X\n", status);
    }
};

static Device device;

void chipInfo(void)
{
  Device::VERSION version;
  Device::STATUS status = device.chipVersion(version);
  if (status == Device::STATUS_OK)
  {
    printf("Chip Name: %s", device.chipName(version));
    printf(", Flash: %u Kb, Ram: %u Kb, Type: %u\n",
        device.chipFlashSize(version) / 1024,
        device.chipRamSize(version) / 1024,
        device.chipType(version));
  }
  else
    printf("Error: 0x%02X\n", status);
}

void portScan(void)
{
  int count = device.getDeviceCount();
  printf("Device Count: %d\n", count);
  for (int i = 0; i < count; ++i)
  {
    char buf[128];
    printf("Device-%d: ", i);
    if (device.begin(i))
    {
      printf("Port: Com%u", device.getComPortNumber());
      device.end();
      device.getDeviceSerial(i, buf);
      printf(", Serial: %s", buf);
      device.getDeviceDescription(i, buf);
      printf(", Description: %s", buf);
    }
    else
      printf("-- Open failure --");
    printf("\n");
  }
}

void usage(bool help)
{
  printf("OTA Update Utility for NXP JN516X, Version 1.0\n");
  printf("Copyright(c) 2022 Sasapea's Lab. All right reserved.\n");
  printf("\n");
  if (help)
  {
    printf("Usage: JN516X-OTA [options]\n");
    printf("\n");
    printf("  options:\n");
    printf("    -s          ... FTD2XX Port Scan\n");
    printf("    -p portname ... FTD2XX Serial Number for Open\n");
    printf("    -w filename ... write device (.bin)\n");
    printf("    -a address  ... device address (*0 - n)\n");
    printf("    -d          ... device information\n");
    printf("    -h          ... this help\n");
    printf("\n");
  }
}

int main(int argc, char **argv)
{
  bool help = false;
  bool scan = false;
  bool info = false;
  const char *portname = "";
  const char *firmware = "";
  Device::SPEED speed = Device::SPEED_1M;
  uint16_t address = 0;

  for (int i = 1; i < argc; )
  {
    char *p = argv[i++];
    if (*p == '-')
    {
      switch (*++p)
      {
        case 'h':
          help = true;
          break;
        case 's':
          scan = true;
          break;
        case 'p':
          if (i < argc)
            portname = argv[i++];
          break;
        case 'w':
          if (i < argc)
            firmware = argv[i++];
          break;
        case 'a':
          if (i < argc)
            address = atoi(argv[i++]);
          break;
        case 'd':
          info = true;
          break;
        default:
          help = true;
          break;
      }
    }
    else
      help = true;
  }

  if (help)
    usage(true);
  else if (device.status() != FT_OK)
  {
    usage(false);
    printf("FTD2XX Library Not Found.");
  }
  else if (scan)
  {
    usage(false);
    portScan();
  }
  else if (device.begin(portname, speed, address, argv[0]))
  {
    usage(false);
    if (info)
      chipInfo();
    if (*firmware)
      device.update(firmware);
    device.end();
  }
  else
  {
    usage(false);
    printf("Port Open Failed: \"%s\"\n", portname);
  }

  return 0;
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

main.cpp - OTA Update Utility for NXP JN516x Series

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

#include <stdio.h>

#include <stdint.h>

#include <stdbool.h>

#include "jn516x_ota.h"

class Device : public JN516x_OTA

{

public:

Device(void) {}

virtual ~Device(void) {}

protected:

void programStart(const char *chipname, const char *filename, bool program) override

{

if (program)

printf("Write Device [%s] <- \"%s\"\n", chipname, filename);

else

printf("Read Device [%s] -> \"%s\"\n", chipname, filename);

}

void programProgress(size_t size, size_t processed) override

{

printf("Progress: %6llu/%6llu\r", processed, size);

}

void programEnd(STATUS status) override

{

if (status == STATUS_OK)

printf("\nSuccess.\n");

else if (status == STATUS_INVALID_DEVICE)

printf("\nError: Not Supported Device\n");

else if (status == STATUS_INVALID_FILE)

printf("\nError: Other device binaries (.bin)\n");

else

printf("\nError: 0x%02X\n", status);

}

};

static Device device;

void chipInfo(void)

{

Device::VERSION version;

Device::STATUS status = device.chipVersion(version);

if (status == Device::STATUS_OK)

{

printf("Chip Name: %s", device.chipName(version));

printf(", Flash: %u Kb, Ram: %u Kb, Type: %u\n",

device.chipFlashSize(version) / 1024,

device.chipRamSize(version) / 1024,

device.chipType(version));

}

else

printf("Error: 0x%02X\n", status);

}

void portScan(void)

{

int count = device.getDeviceCount();

printf("Device Count: %d\n", count);

for (int i = 0; i < count; ++i)

{

char buf[128];

printf("Device-%d: ", i);

if (device.begin(i))

{

printf("Port: Com%u", device.getComPortNumber());

device.end();

device.getDeviceSerial(i, buf);

printf(", Serial: %s", buf);

device.getDeviceDescription(i, buf);

printf(", Description: %s", buf);

}

else

printf("-- Open failure --");

printf("\n");

}

void usage(bool help)

{

printf("OTA Update Utility for NXP JN516X, Version 1.0\n");

printf("\n");

if (help)

{

printf("Usage: JN516X-OTA [options]\n");

printf("\n");

printf(" options:\n");

printf(" -s ... FTD2XX Port Scan\n");

printf(" -p portname ... FTD2XX Serial Number for Open\n");

printf(" -w filename ... write device (.bin)\n");

printf(" -a address ... device address (*0 - n)\n");

printf(" -d ... device information\n");

printf(" -h ... this help\n");

printf("\n");

}

int main(int argc, char **argv)

{

bool help = false;

bool scan = false;

bool info = false;

const char *portname = "";

const char *firmware = "";

Device::SPEED speed = Device::SPEED_1M;

uint16_t address = 0;

for (int i = 1; i < argc; )

{

char *p = argv[i++];

if (*p == '-')

{

switch (*++p)

{

case 'h':

help = true;

break;

case 's':

scan = true;

break;

case 'p':

if (i < argc)

portname = argv[i++];

break;

case 'w':

if (i < argc)

firmware = argv[i++];

break;

case 'a':

if (i < argc)

address = atoi(argv[i++]);

break;

case 'd':

info = true;

break;

default:

help = true;

break;

}

else

help = true;

}

if (help)

usage(true);

else if (device.status() != FT_OK)

{

usage(false);

printf("FTD2XX Library Not Found.");

}

else if (scan)

{

usage(false);

portScan();

}

else if (device.begin(portname, speed, address, argv[0]))

{

usage(false);

if (info)

chipInfo();

if (*firmware)

device.update(firmware);

device.end();

}

else

{

usage(false);

printf("Port Open Failed: \"%s\"\n", portname);

}

return 0;

}

/*
 jn516x_ota.h - OTA Library for NXP JN516x Series

 Copyright (c) 2022 Sasapea's Lab. All right reserved.

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2.1 of the License, or (at your option) any later version.

 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General
 Public License along with this library; if not, write to the
 Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 Boston, MA  02111-1307  USA
 */
#pragma once

#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include "ftd2.h"
#include "crc32.h"
#include "sleep.h"
#include "jn516x.h"

#define DEBUG_TX_PACKET_DUMP 0
#define DEBUG_RX_PACKET_DUMP 0
#define OTA_RETRY_COUNT      5

#define OTA_BOOT_FARMWARE "-OTA-BOOT.bin"

#define ACK 0x06
#define NAK 0x15

class JN516x_OTA : public JN516x, public FTD2
{
  public:

    typedef enum
    {
      STATUS_OK             = OTA_STATUS_OK,
      STATUS_ARG_ERROR      = OTA_STATUS_ARG_ERROR,
      STATUS_BLD_ERROR      = OTA_STATUS_BLD_ERROR,
      STATUS_CRC_ERROR      = OTA_STATUS_CRC_ERROR,
      STATUS_SDK_ERROR      = OTA_STATUS_SDK_ERROR,
      STATUS_INVALID_DEVICE = 0xF0,
      STATUS_INVALID_FILE   = 0xF1,
      STATUS_OPEN_ERROR     = 0xF2,
      STATUS_READ_ERROR     = 0xF3,
      STATUS_TX_ERROR       = 0xF4,
      STATUS_RX_ERROR       = 0xF5,
    } STATUS;

    JN516x_OTA(void)
    : _address(0)
    , _otaboot(false)
    {
    }

    virtual ~JN516x_OTA(void)
    {
    }

    bool begin(int index)
    {
      return FTD2::begin(index);
    }

    bool begin(const char *portname, SPEED speed, uint16_t addr, const char *argv0)
    {
      _address = addr;
      savePath(_path, argv0);
      return FTD2::begin(portname, speed, MODE_8N1, FLOW_RTS_CTS);
    }

    STATUS update(const char *filename)
    {
      STATUS status;
      VERSION chipver;
      status = chipVersion(chipver);
      programStart(chipName(chipver), filename, true);
      if (status == STATUS_OK)
      {
        if (!chipver)
          status = STATUS_INVALID_DEVICE;
        else
        {
          FILE *fp;
          status = STATUS_OPEN_ERROR;
          if ((fp = fopen(filename, "rb")))
          {
            VERSION filever;
            if (!fileVersion(filever, fp))
              status = STATUS_READ_ERROR;
            else if (chipver != filever)
              status = STATUS_INVALID_FILE;
            else
            {
              size_t fpos = (chipver == VERSION_JN5179 ? 0 : ftell(fp));
              fseek(fp, 0, SEEK_END);
              size_t size = ftell(fp) - fpos;
              fseek(fp, fpos, SEEK_SET);
              if (size >= FLASH_SECTOR_OFFSET(chipFlashSectors(chipver) - 1))
                status = STATUS_INVALID_FILE;
              else if (!strstr(filename, OTA_BOOT_FARMWARE))
                status = ota(fp, size, _address);       // Update App
              else if (size <= FLASH_SECTOR_OFFSET(1))
                status = ota(fp, size, _address, true); // Update OTA-BOOT
              else
                status = STATUS_INVALID_FILE;
            }
            fclose(fp);
          }
        }
      }
      programEnd(status);
      return status;
    }

    STATUS chipVersion(VERSION& version)
    {
      STATUS status = protocol(_address, OTA_UPDATE_CHIPVER);
      version  = (VERSION)(status == STATUS_OK ? read32(_packet + 3) : 0);
      _otaboot = _packet[7];
      return status;
    }

  protected:

    virtual void programStart(const char *chipname, const char *filename, bool program) {}
    virtual void programProgress(size_t size, size_t processed) {}
    virtual void programEnd(STATUS status) {}

  private:

    bool fileVersion(VERSION& version, FILE *fp)
    {
      uint8_t data[4];
      fseek(fp, 0, SEEK_SET);
      if (fread(data, 1, sizeof(data), fp) != sizeof(data))
        return false;
      version = (VERSION)read32(data);
      return true;
    }

    void savePath(char *save, const char *path)
    {
      char c, *dir = save;
      while (*path)
      {
        c = *save++ = *path++;
        if ((c == '/') || (c == '\\'))
          dir = save;
      }
      *dir = 0;
    }

    void write32(uint8_t *buf, uint32_t data)
    {
      buf[3] = (uint8_t)(data >>  0);
      buf[2] = (uint8_t)(data >>  8);
      buf[1] = (uint8_t)(data >> 16);
      buf[0] = (uint8_t)(data >> 24);
    }

    uint32_t read32(const uint8_t *buf)
    {
      return
        ((uint32_t)buf[0] << 24) |
        ((uint32_t)buf[1] << 16) |
        ((uint16_t)buf[2] <<  8) |
        ((uint8_t )buf[3] <<  0);
    }

    void dump(const uint8_t *buf, uint8_t len)
    {
      int i = 0;
      while (i < len)
      {
        printf("%02X ", *buf++);
        if ((++i % 16) == 0)
          printf("\n");
      }
      if ((i % 16) != 0)
        printf("\n");
    }

    uint8_t csum(void *buf, size_t len)
    {
      uint8_t *p = (uint8_t *)buf;
      uint8_t  c = 0;
      while (len--)
        c ^= *p++;
      return c;
    }

    STATUS protocol(uint16_t addr, OTA_UPDATE cmd, const uint8_t *buf = 0, uint8_t len = 0)
    {
      STATUS status;
      size_t n, cnt;
      // packet[0]: len (n + 4)
      // packet[1]: addr-hi
      // packet[2]: addr-lo
      // packet[3]: command
      // packet[4]: data (n bytes)
      // packet[4 + n]: csum
      for (int i = 0; i < OTA_RETRY_COUNT; ++i)
      {
        uint8_t ack = NAK;
        for (int j = 0; j < 3; ++j)
        {
          _packet[1] = (uint8_t)(addr >> 8);
          _packet[2] = (uint8_t)(addr >> 0);
          _packet[3] = cmd;
          memcpy(_packet + 4, buf, len);
          _packet[0] = cnt = 4 + len;
          _packet[cnt] = csum(_packet, cnt);
          ++cnt;
#if DEBUG_TX_PACKET_DUMP
          dump(_packet, cnt);
#endif
          if (write(_packet, cnt) == cnt)
          {
            if (read(&ack, sizeof(ack)) == sizeof(ack))
            {
              if (ack == ACK)
                break;
            }
          }
          Sleep::sleep(100);
        }
        if (ack == NAK)
          return STATUS_TX_ERROR;
        for (cnt = _packet[0] = 0; cnt <= _packet[0]; cnt += n)
        {
          if ((n = read(_packet + cnt, _packet[0] - cnt + 1)) == 0)
            break;
        }
#if DEBUG_RX_PACKET_DUMP
        if (_packet[1] == OTA_UPDATE_CHIPVER)
          dump(_packet, cnt);
#endif
        if (cnt < 4)
          status = STATUS_RX_ERROR;
        else if (csum(_packet, cnt))
          status = STATUS_CRC_ERROR;
        else
          return (STATUS)_packet[2];
        cmd = OTA_UPDATE_RETRY;
        len = 0;
        Sleep::sleep(100);
      }
      return status;
    }

    STATUS ota(FILE *fp, size_t size, uint16_t addr, bool bldupd = false)
    {
      STATUS status;
      uint8_t len, buf[96];

      buf[0] = bldupd ? 0xBF : 0x00;
      if (!_otaboot && !bldupd)
        status = STATUS_BLD_ERROR;
      else if ((status = protocol(addr, OTA_UPDATE_BLDMODE, buf, sizeof(buf[0]))) == STATUS_OK)
      {
        if (!bldupd)
        {
          Sleep::sleep(500);
          addr = ADDR_OTA_BOOT;
        }
        if ((status = protocol(addr, OTA_UPDATE_START)) == STATUS_OK)
        {
          size_t progress = 0;
          size_t prog = 0;
          CRC32::init();
          size = (size + 15) & ~0x0F; // 16-byte boundary
          while (1)
          {
            memset(buf, 0xFF, sizeof(buf));
            if ((len = (size_t)fread(buf, 1, sizeof(buf), fp)) == 0)
              break;
            len = (len + 15) & ~0x0F; // 16-byte boundary
            if ((status = protocol(addr, OTA_UPDATE_PROGRAM, buf, len)) != STATUS_OK)
              break;
            CRC32::update(buf, len);
            progress += len;
            if (prog != (progress >> 10))
            {
              prog = (progress >> 10);
              programProgress(size, progress);
            }
          }
          programProgress(size, progress);
        }
        write32(buf, CRC32::result());
        status = protocol(addr, OTA_UPDATE_END, buf, 4);
      }
      return status;
    }

    uint16_t _address;
    bool     _otaboot;
    uint8_t  _packet[256];
    char     _path[PATH_MAX];
};

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

jn516x_ota.h - OTA Library for NXP JN516x Series

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

#pragma once

#include <stdio.h>

#include <stdlib.h>

#include <stdint.h>

#include <stdbool.h>

#include <string.h>

#include "ftd2.h"

#include "crc32.h"

#include "sleep.h"

#include "jn516x.h"

#define DEBUG_TX_PACKET_DUMP 0

#define DEBUG_RX_PACKET_DUMP 0

#define OTA_RETRY_COUNT 5

#define OTA_BOOT_FARMWARE "-OTA-BOOT.bin"

#define ACK 0x06

#define NAK 0x15

class JN516x_OTA : public JN516x, public FTD2

{

public:

typedef enum

{

STATUS_OK = OTA_STATUS_OK,

STATUS_ARG_ERROR = OTA_STATUS_ARG_ERROR,

STATUS_BLD_ERROR = OTA_STATUS_BLD_ERROR,

STATUS_CRC_ERROR = OTA_STATUS_CRC_ERROR,

STATUS_SDK_ERROR = OTA_STATUS_SDK_ERROR,

STATUS_INVALID_DEVICE = 0xF0,

STATUS_INVALID_FILE = 0xF1,

STATUS_OPEN_ERROR = 0xF2,

STATUS_READ_ERROR = 0xF3,

STATUS_TX_ERROR = 0xF4,

STATUS_RX_ERROR = 0xF5,

} STATUS;

JN516x_OTA(void)

: _address(0)

, _otaboot(false)

{

}

virtual ~JN516x_OTA(void)

{

}

bool begin(int index)

{

return FTD2::begin(index);

}

bool begin(const char *portname, SPEED speed, uint16_t addr, const char *argv0)

{

_address = addr;

savePath(_path, argv0);

return FTD2::begin(portname, speed, MODE_8N1, FLOW_RTS_CTS);

}

STATUS update(const char *filename)

{

STATUS status;

VERSION chipver;

status = chipVersion(chipver);

programStart(chipName(chipver), filename, true);

if (status == STATUS_OK)

{

if (!chipver)

status = STATUS_INVALID_DEVICE;

else

{

FILE *fp;

status = STATUS_OPEN_ERROR;

if ((fp = fopen(filename, "rb")))

{

VERSION filever;

if (!fileVersion(filever, fp))

status = STATUS_READ_ERROR;

else if (chipver != filever)

status = STATUS_INVALID_FILE;

else

{

size_t fpos = (chipver == VERSION_JN5179 ? 0 : ftell(fp));

fseek(fp, 0, SEEK_END);

size_t size = ftell(fp) - fpos;

fseek(fp, fpos, SEEK_SET);

if (size >= FLASH_SECTOR_OFFSET(chipFlashSectors(chipver) - 1))

status = STATUS_INVALID_FILE;

else if (!strstr(filename, OTA_BOOT_FARMWARE))

status = ota(fp, size, _address); // Update App

else if (size <= FLASH_SECTOR_OFFSET(1))

status = ota(fp, size, _address, true); // Update OTA-BOOT

else

status = STATUS_INVALID_FILE;

}

fclose(fp);

}

programEnd(status);

return status;

}

STATUS chipVersion(VERSION& version)

{

STATUS status = protocol(_address, OTA_UPDATE_CHIPVER);

version = (VERSION)(status == STATUS_OK ? read32(_packet + 3) : 0);

_otaboot = _packet[7];

return status;

}

protected:

virtual void programStart(const char *chipname, const char *filename, bool program) {}

virtual void programProgress(size_t size, size_t processed) {}

virtual void programEnd(STATUS status) {}

private:

bool fileVersion(VERSION& version, FILE *fp)

{

uint8_t data[4];

fseek(fp, 0, SEEK_SET);

if (fread(data, 1, sizeof(data), fp) != sizeof(data))

return false;

version = (VERSION)read32(data);

return true;

}

void savePath(char *save, const char *path)

{

char c, *dir = save;

while (*path)

{

c = *save++ = *path++;

if ((c == '/') || (c == '\\'))

dir = save;

}

*dir = 0;

}

void write32(uint8_t *buf, uint32_t data)

{

buf[3] = (uint8_t)(data >> 0);

buf[2] = (uint8_t)(data >> 8);

buf[1] = (uint8_t)(data >> 16);

buf[0] = (uint8_t)(data >> 24);

}

uint32_t read32(const uint8_t *buf)

{

return

((uint32_t)buf[0] << 24) |

((uint32_t)buf[1] << 16) |

((uint16_t)buf[2] << 8) |

((uint8_t )buf[3] << 0);

}

void dump(const uint8_t *buf, uint8_t len)

{

int i = 0;

while (i < len)

{

printf("%02X ", *buf++);

if ((++i % 16) == 0)

printf("\n");

}

if ((i % 16) != 0)

printf("\n");

}

uint8_t csum(void *buf, size_t len)

{

uint8_t *p = (uint8_t *)buf;

uint8_t c = 0;

while (len--)

c ^= *p++;

return c;

}

STATUS protocol(uint16_t addr, OTA_UPDATE cmd, const uint8_t *buf = 0, uint8_t len = 0)

{

STATUS status;

size_t n, cnt;

// packet[0]: len (n + 4)

// packet[1]: addr-hi

// packet[2]: addr-lo

// packet[3]: command

// packet[4]: data (n bytes)

// packet[4 + n]: csum

for (int i = 0; i < OTA_RETRY_COUNT; ++i)

{

uint8_t ack = NAK;

for (int j = 0; j < 3; ++j)

{

_packet[1] = (uint8_t)(addr >> 8);

_packet[2] = (uint8_t)(addr >> 0);

_packet[3] = cmd;

memcpy(_packet + 4, buf, len);

_packet[0] = cnt = 4 + len;

_packet[cnt] = csum(_packet, cnt);

++cnt;

#if DEBUG_TX_PACKET_DUMP

dump(_packet, cnt);

#endif

if (write(_packet, cnt) == cnt)

{

if (read(&ack, sizeof(ack)) == sizeof(ack))

{

if (ack == ACK)

break;

}

Sleep::sleep(100);

}

if (ack == NAK)

return STATUS_TX_ERROR;

for (cnt = _packet[0] = 0; cnt <= _packet[0]; cnt += n)

{

if ((n = read(_packet + cnt, _packet[0] - cnt + 1)) == 0)

break;

}

#if DEBUG_RX_PACKET_DUMP

if (_packet[1] == OTA_UPDATE_CHIPVER)

dump(_packet, cnt);

#endif

if (cnt < 4)

status = STATUS_RX_ERROR;

else if (csum(_packet, cnt))

status = STATUS_CRC_ERROR;

else

return (STATUS)_packet[2];

cmd = OTA_UPDATE_RETRY;

len = 0;

Sleep::sleep(100);

}

return status;

}

STATUS ota(FILE *fp, size_t size, uint16_t addr, bool bldupd = false)

{

STATUS status;

uint8_t len, buf[96];

buf[0] = bldupd ? 0xBF : 0x00;

if (!_otaboot && !bldupd)

status = STATUS_BLD_ERROR;

else if ((status = protocol(addr, OTA_UPDATE_BLDMODE, buf, sizeof(buf[0]))) == STATUS_OK)

{

if (!bldupd)

{

Sleep::sleep(500);

addr = ADDR_OTA_BOOT;

}

if ((status = protocol(addr, OTA_UPDATE_START)) == STATUS_OK)

{

size_t progress = 0;

size_t prog = 0;

CRC32::init();

size = (size + 15) & ~0x0F; // 16-byte boundary

while (1)

{

memset(buf, 0xFF, sizeof(buf));

if ((len = (size_t)fread(buf, 1, sizeof(buf), fp)) == 0)

break;

len = (len + 15) & ~0x0F; // 16-byte boundary

if ((status = protocol(addr, OTA_UPDATE_PROGRAM, buf, len)) != STATUS_OK)

break;

CRC32::update(buf, len);

progress += len;

if (prog != (progress >> 10))

{

prog = (progress >> 10);

programProgress(size, progress);

}

programProgress(size, progress);

}

write32(buf, CRC32::result());

status = protocol(addr, OTA_UPDATE_END, buf, 4);

}

return status;

}

uint16_t _address;

bool _otaboot;

uint8_t _packet[256];

char _path[PATH_MAX];

};

/*
  sleep.h - Sleep Library

  Copyright (c) 2022 Sasapea's Lab. All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/
#pragma once

#ifdef __linux__
  #include <time.h>
#else
  #include <windows.h>
#endif

class Sleep
{
  public:

    static void
    sleep(unsigned long ms)
    {
#ifdef __linux__
      struct timespec req;
      req.tv_sec  = (ms / 1000);
      req.tv_nsec = (ms % 1000) * 1000000;
      nanosleep(&req, NULL);
#else
      ::Sleep(ms);
#endif
    }
};

sleep.h - Sleep Library

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

#pragma once

#ifdef __linux__

#include <time.h>

#else

#include <windows.h>

#endif

class Sleep

{

public:

static void

sleep(unsigned long ms)

{

#ifdef __linux__

struct timespec req;

req.tv_sec = (ms / 1000);

req.tv_nsec = (ms % 1000) * 1000000;

nanosleep(&req, NULL);

#else

::Sleep(ms);

#endif

}

};

/*
  crc32.cpp - CRC32 Library

  Copyright (c) 2022 Sasapea's Lab. All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/
#pragma once

#include <stdint.h>

class CRC32
{
  public:

    typedef enum
    {
      POLY_IEEE802_3 = 0xEDB88320, // CRC-32-IEEE 802.3
    } POLY;

    static
    void init(uint32_t initval = (uint32_t)-1, POLY poly = POLY_IEEE802_3)
    {
      _result = initval;
      for (uint32_t i = 0; i < 256; i++)
      {
        uint32_t c = i;
        for (int j = 0; j < 8; j++)
          c = c & 1 ? poly ^ (c >> 1) : c >> 1;
        _lookup[i] = c;
      }
    }

    static
    void update(const uint8_t *buf, uint32_t len)
    {
      for (uint32_t i = 0; i < len; i++)
        _result = _lookup[(_result ^ *buf++) & 0xFF] ^ (_result >> 8);
    }

    static
    uint32_t result(uint32_t xorout = (uint32_t)-1)
    {
      return _result ^ xorout;
    }

  private:

    static uint32_t _result;
    static uint32_t _lookup[256];
};

crc32.cpp - CRC32 Library

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

#pragma once

#include <stdint.h>

class CRC32

{

public:

typedef enum

{

POLY_IEEE802_3 = 0xEDB88320, // CRC-32-IEEE 802.3

} POLY;

static

void init(uint32_t initval = (uint32_t)-1, POLY poly = POLY_IEEE802_3)

{

_result = initval;

for (uint32_t i = 0; i < 256; i++)

{

uint32_t c = i;

for (int j = 0; j < 8; j++)

c = c & 1 ? poly ^ (c >> 1) : c >> 1;

_lookup[i] = c;

}

static

void update(const uint8_t *buf, uint32_t len)

{

for (uint32_t i = 0; i < len; i++)

_result = _lookup[(_result ^ *buf++) & 0xFF] ^ (_result >> 8);

}

static

uint32_t result(uint32_t xorout = (uint32_t)-1)

{

return _result ^ xorout;

}

private:

static uint32_t _result;

static uint32_t _lookup[256];

};

/*
  crc32.cpp - CRC32 Library

  Copyright (c) 2022 Sasapea's Lab. All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/
#include "crc32.h"

uint32_t CRC32::_result;
uint32_t CRC32::_lookup[256];

crc32.cpp - CRC32 Library

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

#include "crc32.h"

uint32_t CRC32::_result;

uint32_t CRC32::_lookup[256];

/*
  jn516x.h - JN516x Chip Library for NXP JN516x Series

  Copyright (c) 2022 Sasapea's Lab. All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/
#pragma once

#include <stdint.h>

#define FLASH_START_ADDRESS      0x80000U
#define FLASH_SECTOR_OFFSET(sec) (0x8000U * (sec))

class JN516x
{
  public:

    static const uint8_t MAGICNUMBER[12];
    static const uint8_t MAGICNUMBER_JN5179[12];

    typedef struct __attribute__((packed))
    {
      uint8_t  magicNumber[12];
      uint8_t  configuration;
      uint8_t  status;
      uint16_t applicationID;
    } tsBIR;

    typedef struct __attribute__((packed))
    {
      tsBIR    sBIR;           // 16-byte Boot Image Record
      uint8_t  encryption[14]; // Encryption Initialisation Vector (ignored if unencrypted)
      uint16_t configuration;  // 16-bit Software Configuration Options
      uint32_t imageSize;      // 32-bit Length of Binary Image in bytes
      uint32_t dataStart;      // 32-bit .data section Flash start address
      uint16_t dataAddress;    // 16-bit .data section load address in RAM (word aligned)
      uint16_t dataLength;     // 16-bit .data section length in 32-bit words
      uint16_t bssStart;       // 16 bit .bss section start address in RAM (word aligned)
      uint16_t bssLength;      // 16-bit .bss section length in 32-bit words
      uint32_t warmStart;      // 32-bit wake-up entry point (word aligned) – warm start
      uint32_t coldStart;      // 32-bit reset entry point (word aligned) – cold start
    } tsFlashHeader;

    typedef struct __attribute__((packed))
    {
      uint32_t version;        // version
      tsBIR    sBIR;           // 16-byte Boot Image Record
      uint8_t  encryption[14]; // Encryption Initialisation Vector (ignored if unencrypted)
      uint16_t configuration;  // 16-bit Software Configuration Options
      uint32_t imageSize;      // 32-bit Length of Binary Image in bytes
      uint32_t dataStart;      // 32-bit .data section Flash start address
      uint16_t dataAddress;    // 16-bit .data section load address in RAM (word aligned)
      uint16_t dataLength;     // 16-bit .data section length in 32-bit words
      uint16_t bssStart;       // 16 bit .bss section start address in RAM (word aligned)
      uint16_t bssLength;      // 16-bit .bss section length in 32-bit words
      uint32_t warmStart;      // 32-bit wake-up entry point (word aligned) – warm start
      uint32_t coldStart;      // 32-bit reset entry point (word aligned) – cold start
    } tsFlashHeader_JN5179;

    typedef enum
    {
      CHIPID_JN5179 = 1U,          // Survey required.
      CHIPID_JN5169 = 0x0100B686U,
      CHIPID_JN5168 = 0x10008686U,
      CHIPID_JN5164 = 0x10408686U,
      CHIPID_JN5161 = 0U,          // Survey required.
      CHIPID_JN5148 = 0x10404686U,
      CHIPID_JN5142 = 0x00005686U,
      CHIPID_JN5139 = 0x10002000U,
    } CHIPID;

    typedef enum
    {
      VERSION_JN5179 = 0x0F03000AU,
      VERSION_JN5169 = 0x0F03000BU,
      VERSION_JN5168 = 0x07030008U,
      VERSION_JN5164 = 0x04030008U,
      VERSION_JN5161 = 0x01000008U,
    } VERSION;

    typedef enum
    {
      FLASHID_ST_M25P05_A    = 0x0505U,
      FLASHID_ST_M25P10_A    = 0x1010U,
      FLASHID_ST_M25P20_A    = 0x1101U,
      FLASHID_ST_M25P40      = 0x1212U,
      FLASHID_SST_25VF010A   = 0xBF49U,
      FLASHID_ATMEL_25F512   = 0x1F60U,
      FLASHID_INTERNAL_FLASH = 0xCCEEU, // JN516x/7x only
    } FLASHID;

    typedef enum
    {
      FLASH_ST_M25P05_A    = 4U,
      FLASH_ST_M25P10_A    = 0U,
      FLASH_ST_M25P20_A    = 5U,
      FLASH_ST_M25P40      = 3U,
      FLASH_SST_25VF010A   = 1U,
      FLASH_ATMEL_25F512   = 2U,
      FLASH_INTERNAL_FLASH = 8U, // JN516x/7x only
    } FLASH;

    typedef enum
    {
      ADDR_BROADCAST   = 0xFFFFU,
      ADDR_OTA_BOOT    = ADDR_BROADCAST - 1,
      ADDR_OTA_BRIDGE  = ADDR_BROADCAST - 2,
      ADDR_OTA_BRIDGE2 = ADDR_BROADCAST - 3,
    } ADDR;

    typedef enum
    {
      OTA_UPDATE_CHIPVER  = 0xC0U,
      OTA_UPDATE_BLDMODE  = 0xC1U,
      OTA_UPDATE_START    = 0xC2U,
      OTA_UPDATE_PROGRAM  = 0xC3U,
      OTA_UPDATE_END      = 0xC4U,
      OTA_UPDATE_RETRY    = 0xC5U, /* only Bridge */
    } OTA_UPDATE;

    typedef enum
    {
      OTA_STATUS_OK        = 0x00U,
      OTA_STATUS_ARG_ERROR = 0xFAU,
      OTA_STATUS_BLD_ERROR = 0xFBU,
      OTA_STATUS_CRC_ERROR = 0xFCU,
      OTA_STATUS_SDK_ERROR = 0xFDU,
    } OTA_STATUS;

    static
    VERSION chipVersion(CHIPID id)
    {
      switch (id)
      {
        case CHIPID_JN5179: return VERSION_JN5179;
        case CHIPID_JN5169: return VERSION_JN5169;
        case CHIPID_JN5168: return VERSION_JN5168;
        case CHIPID_JN5164: return VERSION_JN5164;
        case CHIPID_JN5161: return VERSION_JN5161;
        default: break;
      }
      return (VERSION)0;
    }

    static
    const char *chipName(VERSION version)
    {
      switch (version)
      {
        case VERSION_JN5179: return "JN5179";
        case VERSION_JN5169: return "JN5169";
        case VERSION_JN5168: return "JN5168";
        case VERSION_JN5164: return "JN5164";
        case VERSION_JN5161: return "JN5161";
        default: break;
      }
      return "(unknown)";
    }

    static
    uint32_t chipFlashSectors(VERSION version)
    {
      return (uint8_t)(version >> 24) + 1;
    }

    static
    uint32_t chipFlashSize(VERSION version)
    {
      return 32768U * chipFlashSectors(version);
    }

    static
    uint32_t chipRamSize(VERSION version)
    {
      return 8192U * ((uint8_t)(version >> 16) + 1);
    }

    static
    uint16_t chipType(VERSION version)
    {
      return (uint16_t)version;
    }
};

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

jn516x.h - JN516x Chip Library for NXP JN516x Series

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

#pragma once

#include <stdint.h>

#define FLASH_START_ADDRESS 0x80000U

#define FLASH_SECTOR_OFFSET(sec) (0x8000U * (sec))

class JN516x

{

public:

static const uint8_t MAGICNUMBER[12];

static const uint8_t MAGICNUMBER_JN5179[12];

typedef struct __attribute__((packed))

{

uint8_t magicNumber[12];

uint8_t configuration;

uint8_t status;

uint16_t applicationID;

} tsBIR;

typedef struct __attribute__((packed))

{

tsBIR sBIR; // 16-byte Boot Image Record

uint8_t encryption[14]; // Encryption Initialisation Vector (ignored if unencrypted)

uint16_t configuration; // 16-bit Software Configuration Options

uint32_t imageSize; // 32-bit Length of Binary Image in bytes

uint32_t dataStart; // 32-bit .data section Flash start address

uint16_t dataAddress; // 16-bit .data section load address in RAM (word aligned)

uint16_t dataLength; // 16-bit .data section length in 32-bit words

uint16_t bssStart; // 16 bit .bss section start address in RAM (word aligned)

uint16_t bssLength; // 16-bit .bss section length in 32-bit words

uint32_t warmStart; // 32-bit wake-up entry point (word aligned) – warm start

uint32_t coldStart; // 32-bit reset entry point (word aligned) – cold start

} tsFlashHeader;

typedef struct __attribute__((packed))

{

uint32_t version; // version