IRIS測定装置の開発

こんにちは、Habrコミュニティ。最近、当社はIRIS測定および制御装置を市場に投入しました。このプロジェクトのメインプログラマーとして、デバイスファームウェアの開発についてお話ししたいと思います（プロジェクトマネージャーによると、ファームウェアはアイデアから大量生産までの総作業量の30％以下です）。この記事は、「実際の」プロジェクトの人件費と「内部を見たい」ユーザーを理解するという点で、初心者の開発者にとって主に役立ちます。

デバイスの目的

IRISは多機能測定装置です。彼は、電流（ammeter）、電圧（voltmeter）、電力（wattmeter）、およびその他の多くの量を測定する方法を知っています。KIP IRISは最大値を記憶し、オシログラムを書き込みます。デバイスの詳細な説明は、会社のWebサイトにあります。

ちょっとした統計

タイミング

SVNへの最初のコミット：2019年5月16日

リリース：2020年6月19日。

*これは暦時間であり、期間中のフルタイムの開発ではありません。他のプロジェクトへの気晴らし、技術仕様への期待、ハードウェアの反復などがありました。

コミット

SVNの番号：928

これはどこから来たのですか？

1）開発中のマイクロコミットメントのサポーターです

2）ハードウェアとエミュレーターのブランチで重複します

3）ドキュメント

したがって、新しいコード（トランクブランチ）の形式のペイロードを持つ数は300以下です。

コードの行数

統計は、HALSTM32およびESP-IDFESP32ソースを除いて、デフォルトのパラメーターを使用してclocユーティリティによって収集されました。



STM32ファームウェア：38,334行のコード。そのうち：

60870-5-101：18751

ModbusRTU：3859

オシロスコープ：1944

アーカイバー：955

ESP32ファームウェア：1537行のコード。

ハードウェアコンポーネント（関連する周辺機器）

デバイスの主な機能は、STM32ファームウェアに実装されています。 ESP32ファームウェアはBluetooth通信を担当します。チップ間の通信はUARTを介して実行されます（ヘッダーの図を参照）。

NVICは割り込みコントローラーです。

IWDG-ファームウェアがハングアップした場合にチップを再起動するためのウォッチドッグタイマー。

タイマー-タイマー割り込みはプロジェクトのハートビートを維持します。

EEPROM-生産情報、設定、最大読み取り値、ADCキャリブレーション係数を保存するためのメモリ。

I2Cは、EEPROMチップにアクセスするためのインターフェイスです。

NOR-波形を保存するためのメモリ。

QSPIは、NORメモリチップにアクセスするためのインターフェイスです。

RTC-リアルタイムクロックは、デバイスの電源を切った後の時間経過を提供します。

ADC-ADC。

RS485は、ModbusRTUおよび60870-101プロトコルを介して接続するためのシリアルインターフェイスです。

DIN、DOUT-個別の入力と出力。

ボタン-測定間で表示を切り替えるためのデバイスのフロントパネル上のボタン。

ソフトウェアアーキテクチャ

主なソフトウェアモジュール

測定データストリーム

オペレーティング・システム

フラッシュメモリの量の制限（OSはオーバーヘッドを導入します）とデバイスの比較的単純さを考慮して、オペレーティングシステムの使用を中止し、中断を回避することが決定されました。このアプローチは、Habréに関する記事ですでに何度も強調されているため、割り込み内のタスクのフローチャートとその優先順位のみを示します。

サンプルコード。STM32での遅延割り込み生成。

//     6
  HAL_NVIC_SetPriority(CEC_IRQn, 6, 0);
  HAL_NVIC_EnableIRQ(CEC_IRQn);

//  
HAL_NVIC_SetPendingIRQ(CEC_IRQn);

// 
void CEC_IRQHandler(void) {
// user code
}

PWM7セグメント表示

デバイスには、4文字の2行、合計8つのインジケーターがあります。7セグメントのディスプレイには、8本の並列データライン（A、B、C、D、E、F、G、DP）と、それぞれに2本の色選択ライン（緑と赤）があります。

波形ストレージ

ストレージは、波形ごとに64 KBスロット（固定サイズ）の循環バッファーの原則に基づいて構成されています。

予期しないシャットダウンが発生した場合のデータの整合性の確保

EEPROMでは、データは2つのコピーに書き込まれ、最後にチェックサムが追加されます。データ記録の時点でデバイスの電源がオフになっている場合、データの少なくとも1つのコピーはそのまま残ります。チェックサムは、オシロスコープデータの各スライス（ADC入力での測定値）にも追加されるため、スライスの無効なチェックサムは、オシログラムの終了の兆候になります。

ソフトウェアバージョンの自動生成

1）version.fmtファイルを作成します。

＃define SVN_REV（$ WCREV $）

2）プロジェクトをビルドする前に、次のコマンドを追加します（System Workbanch用）：

SubWCRev $ {ProjDirPath} $ {ProjDirPath} /version.fmt $ {ProjDirPath} /version.h

このコマンドを実行すると、最後のコミット番号でversion.hファイルが作成されます。



GITにも同様のユーティリティがあります：GitWCRev。/version.fmt ./main/version.h

#define GIT_REV（$ WCLOGCOUNT $）

これにより、コミットとソフトウェアバージョンを明確に一致させることができます。

エミュレータ

なぜなら ファームウェアの開発は、ハードウェアの最初のコピーが登場する前に始まり、その後、コードの一部がPC上のコンソールアプリケーションとして記述され始めました。



利点：-PCの

開発とデバッグは、ハードウェア上で直接行うよりも簡単です。

-任意の入力信号を生成する機能。

-ハードウェアのないPCでクライアントをデバッグする機能。com0comドライバーがPCにインストールされ、comポートのペアが作成されます。1つはエミュレータを起動し、もう1つはクライアントに接続します。

-美しい建築に貢献しているので ハードウェア依存モジュールのインターフェースを選択し、2つの実装を作成する必要があります

サンプルコード。eepromからデータを読み取る2つの実装。

uint32_t eeprom_read(uint32_t offset, uint8_t * buf, uint32_t len);
ifdef STM32H7
uint32_t eeprom_read(uint32_t offset, uint8_t * buf, uint32_t len)
{
  if (diag_isError(ERR_I2C))
    return 0;
	if (eeprom_wait_ready()) {
		HAL_StatusTypeDef status = HAL_I2C_Mem_Read(&I2C_MEM_HANDLE, I2C_MEM_DEV_ADDR, offset, I2C_MEMADD_SIZE_16BIT, buf, len, I2C_MEM_TIMEOUT_MS);
		if (status == HAL_OK)
			return len;
	}
	diag_setError(ERR_I2C, true);
  return 0;
}
#endif
#ifdef _WIN32
static FILE *fpEeprom = NULL;
#define EMUL_EEPROM_FILE "eeprom.bin"
void checkAndCreateEpromFile() {
	if (fpEeprom == NULL) {
		fopen_s(&fpEeprom, EMUL_EEPROM_FILE, "rb+");
		if (fpEeprom == NULL)
			fopen_s(&fpEeprom, EMUL_EEPROM_FILE, "wb+");
		fseek(fpEeprom, EEPROM_SIZE, SEEK_SET);
		fputc('\0', fpEeprom);
		fflush(fpEeprom);
	}
}
uint32_t eeprom_read(uint32_t offset, uint8_t * buf, uint32_t len)
{
	checkAndCreateEpromFile();
	fseek(fpEeprom, offset, SEEK_SET);
	return (uint32_t)fread(buf, len, 1, fpEeprom);
}
#endif

データ転送の高速化（アーカイブ）

オシログラムのダウンロード速度を上げるために、送信前にアーカイブされました。uzlibライブラリはアーカイバーとして使用されました。このフォーマットをC＃で解凍するのは、数行のコードです。

サンプルコード。データのアーカイブ。

#define ARCHIVER_HASH_BITS (12)
uint8_t __RAM_288K archiver_hash_table[sizeof(uzlib_hash_entry_t) * (1 << ARCHIVER_HASH_BITS)];

bool archive(const uint8_t* src, uint32_t src_len, uint8_t* dst, uint32_t dst_len, uint32_t *archive_len)
{
	struct uzlib_comp comp = { 0 };
	comp.dict_size = 32768;
	comp.hash_bits = ARCHIVER_HASH_BITS;
	comp.hash_table = (uzlib_hash_entry_t*)&archiver_hash_table[0];
	memset((void*)comp.hash_table, 0, sizeof(archiver_hash_table));
	comp.out.outbuf = &dst[10]; // skip header 10 bytes
	comp.out.outsize = dst_len - 10 - 8; // skip header 10 bytes and tail(crc+len) 8 bytes
	comp.out.is_overflow = false;

	zlib_start_block(&comp.out);
	uzlib_compress(&comp, src, src_len);
	zlib_finish_block(&comp.out);
	if (comp.out.is_overflow)
		comp.out.outlen = 0;

	dst[0] = 0x1f;
	dst[1] = 0x8b;
	dst[2] = 0x08;
	dst[3] = 0x00; // FLG
	// mtime
	dst[4] =
		dst[5] =
		dst[6] =
		dst[7] = 0;
	dst[8] = 0x04; // XFL
	dst[9] = 0x03; // OS

	unsigned crc = ~uzlib_crc32(src, src_len, ~0);
	memcpy(&dst[10 + comp.out.outlen], &crc, sizeof(crc));
	memcpy(&dst[14 + comp.out.outlen], &src_len, sizeof(src_len));
	*archive_len = 18 + comp.out.outlen;

	if (comp.out.is_overflow)
		return false;
	return true;
}

サンプルコード。データの解凍。

// byte[] res; //  
                        using (var msOut = new MemoryStream())
                        using (var ms = new MemoryStream(res))
                        using (var gzip = new GZipStream(ms, CompressionMode.Decompress))
                        {
                            int chunk = 4096;
                            var buffer = new byte[chunk];
                            int read;
                            do
                            {
                                read = gzip.Read(buffer, 0, chunk);
                                msOut.Write(buffer, 0, read);
                            } while (read == chunk);

                            //msOut.ToArray();//    
                        }

TKの恒久的な変更について

インターネットからのミーム：

-しかし、あなたは委託条件を承認しました！

-技術的なタスク？TKは「視点」だと思っていましたが、いくつかあります。

サンプルコード。キーボードの取り扱い。

enum {
	IVA_KEY_MASK_NONE,
	IVA_KEY_MASK_ENTER = 0x1,
	IVA_KEY_MASK_ANY   = IVA_KEY_MASK_ENTER,
}IVA_KEY;
uint8_t keyboard_isKeyDown(uint8_t keyMask) {
	return ((keyMask & keyStatesMask) == keyMask);
}

そのようなコードを見て、デバイスにボタンが1つしかないのに、なぜ彼がそれをすべて積み上げたのかと思うかもしれません。TKの最初のバージョンには5つのボタンがあり、それらの助けを借りて、デバイス上で直接設定の編集を実装することが計画されていました。

enum {
	IVA_KEY_MASK_NONE  = 0,
	IVA_KEY_MASK_ENTER = 0x01,
	IVA_KEY_MASK_LEFT  = 0x02,
	IVA_KEY_MASK_RIGHT = 0x04,
	IVA_KEY_MASK_UP    = 0x08,
	IVA_KEY_MASK_DOWN  = 0x10,
	IVA_KEY_MASK_ANY   = IVA_KEY_MASK_ENTER | IVA_KEY_MASK_LEFT | IVA_KEY_MASK_RIGHT | IVA_KEY_MASK_UP | IVA_KEY_MASK_DOWN,
}IVA_KEY;

したがって、コードに奇妙な点を見つけた場合、前のプログラマーを悪い言葉ですぐに覚えておく必要はありません。おそらくその時点で、そのような実装には理由がありました。

いくつかの開発上の問題

フラッシュは終わりました

マイクロプロセッサには128KBのフラッシュメモリがあります。ある時点で、デバッグビルドがこのボリュームを超えました。ボリュームによる最適化を有効にする必要がありました-Os。ハードウェアでのデバッグが必要な場合は、一部のソフトウェアモジュール（modbas、101st）を無効にして特別なアセンブリを作成しました。

QSPIデータエラー

qspiを介してデータを読み取るときに、「余分な」バイトが表示されることがありました。qspi割り込みの優先度を上げると、問題は解消されました。

オシロスコープのデータエラー

なぜなら データはDMAによって送信され、プロセッサはそれを「認識」せず、キャッシュから古いデータを読み取ることができません。キャッシュを検証する必要があります。

サンプルコード。キャッシュの検証。

//           QSPI/DMA
SCB_CleanDCache_by_Addr((uint32_t*)(((uint32_t)&data[0]) & 0xFFFFFFE0), dataSize + 32);
//    ADC/DMA      CPU
SCB_InvalidateDCache_by_Addr((uint32_t*)&s_pAlignedAdcBuffer[0], sizeof(s_pAlignedAdcBuffer));

ADCの問題（電源を入れるごとに異なる読み取り値）

スイッチをオンにしてからオンにするまで、現在の読み取り値の異なるオフセット（10〜30 mAのオーダー）がデバイスに現れました。この解決策は、VladislavBarsovとAlexanderKvashinのKompelの同僚によって助けられ、彼らに感謝します。

サンプルコード。ADCの初期化。

//         
HAL_ADCEx_Calibration_SetValue (&hadc1, ADC_SINGLE_ENDED, myCalibrationFactor[0]);
HAL_ADCEx_Calibration_SetValue (&hadc1, ADC_DIFFERENTIAL_ENDED, myCalibrationFactor[1]);
HAL_ADCEx_LinearCalibration_SetValue (&hadc1, &myLinearCalib_Buffer[0]);

ディスプレイのバックライト

「空の」7セグメントディスプレイでは、完全にシャットダウンする代わりに、弱い照明が表示されました。その理由は、現実の世界では波形が理想的ではなく、コードgpio_set_level（0）を実行した場合、信号レベルがすぐに変更されたことを意味しないためです。フレアは、データラインにPWMを追加することによって排除されました。

HALのUartエラー

オーバーランエラーが発生した後、UARTは動作を停止しました。この問題はHALパッチで修正されました。

サンプルコード。HAL'aのパッチ。

---    if (((isrflags & USART_ISR_ORE) != 0U)
---        && (((cr1its & USART_CR1_RXNEIE_RXFNEIE) != 0U) ||
---            ((cr3its & (USART_CR3_RXFTIE | USART_CR3_EIE)) != 0U)))
+++    if ((isrflags & USART_ISR_ORE) != 0U)
    {
      __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF);

アラインされていないデータへのアクセス

エラーは、-Os最適化レベルのアセンブリ内のハードウェアでのみ発生しました。実際のデータの代わりに、modbusクライアントはゼロを読み取ります。

サンプルコード。アラインされていないデータの読み取り中にエラーが発生しました。

	float f_value;
	uint16_t registerValue;
	//     registerValue  0
	//registerValue = ((uint16_t*)&f_value)[(offsetInMaximeterData -
	//	offsetof(mbreg_Maximeter, primaryValue)) / 2];

	//     memcpy  
    memcpy(& registerValue, ((uint16_t*)&f_value) + (offsetInMaximeterData -
        offsetof(mbreg_Maximeter, primaryValue)) / 2, sizeof(uint16_t));

HardFaultの原因を見つける

私が使用する例外ローカリゼーションツールの1つは、ウォッチポイントです。コードの周りにウォッチポイントを分散させ、例外が表示された後、デバッガーに接続して、コードが通過したポイントを確認します。

サンプルコード。SET_DEBUG_POINT（__ LINE__）。

//debug.h
#define USE_DEBUG_POINTS
#ifdef USE_DEBUG_POINTS
//     SET_DEBUG_POINT1(__LINE__)
void SET_DEBUG_POINT1(uint32_t val);
void SET_DEBUG_POINT2(uint32_t val);
#else
#define SET_DEBUG_POINT1(...)
#define SET_DEBUG_POINT2(...)
#endif

//debug.c
#ifdef USE_DEBUG_POINTS
volatile uint32_t dbg_point1 = 0;
volatile uint32_t dbg_point2 = 0;
void SET_DEBUG_POINT1(uint32_t val) {
  dbg_point1 = val;
}
void SET_DEBUG_POINT2(uint32_t val) {
  dbg_point2 = val;
}
#endif

//     :
SET_DEBUG_POINT1(__line__);

初心者のためのヒント

1）コード例を見てください。esp32の場合、SDKには例が含まれています。HALストレージ内のstm32の場合STM32CubeMX \ STM32Cube_FW_H7_V1.7.0 \ Projects \ NUCLEO-H743ZI \ Examples \

2）Google：プログラミングマニュアル<your chip>、テクニカルリファレンスマニュアル<your chip>、アプリケーションノート<your chip>、データシート<yourチップ>。

3）技術的な問題があり、上位2つのポイントが役に立たなかった場合は、サポートへの連絡を怠ってはならず、メーカーの会社のエンジニアと直接連絡を取っているディストリビューターに連絡する必要があります。

4）バグはコードだけでなく、製造元のHALにもあります。



清聴ありがとうございました。