S810-MX-ADL1L からの移行ガイド(CAN/CAN FD)
本ページは、S810-MX-ADL1L(旧)から S810-MX-ADL2L(新)へ移行する際の実装差分を、既存コードの置換観点で整理したガイドです。
対象は CAN/CAN FD です。
関連リンク
- 移行時の問題切り分け: よくある問題と対処
移行の全体像
ADL1L から ADL2L の移行で、実装に影響するポイントは次の5点です。
- DLL名の変更(
MPXCANFDCtrlFree*->MPXCtrlFree*) MPXOpenの引数変更(Num追加)- CAN API名の変更(
MPXSetCANParamなど ->MPXCAN*) - 一部定数名の変更(
MPX_MODE_*、CAN_ERR*) MPXGetLogの引数型変更(StMPXCANLog**->StMPXLog**)
先に確認する移行前提
- 旧DLL:
MPXCANFDCtrlFree.a/MPXCANFDCtrlFree.so - 新DLL:
MPXCtrlFree.a/MPXCtrlFree.so InnerChは従来どおり対象CHを指定(1または2)
API仕様差分(旧->新)
共通API
| ADL1L | ADL2L | 互換性影響 |
|---|---|---|
MPXGetAPIVersion(StMPXAPIVersion*) | 同じ | 変更なし |
MPXOpen(StMPXDeviceInfo* Devices, uint8_t* Count) | MPXOpen(StMPXDeviceInfo* Devices, uint8_t Num, uint8_t* Count) | Num 引数追加 |
MPXClose() | 同じ | 変更なし |
MPXSetLED(...) | 同じ | 変更なし |
MPXGetStatus(...) | 同じ | 変更なし |
MPXMonitorStart(...) | 同じ | 変更なし |
MPXMonitorStop(...) | 同じ | 変更なし |
MPXGetTimeStamp(...) | 同じ | 変更なし |
MPXSetLogCallBack(...) | 廃止 | ログAPIモードに変更 |
MPXSetGetLogMode(...) | 同じ | ログAPIモードの場合は変更なし、コールバックモードの場合はログAPIモードに変更 省略可 |
MPXGetLog(uint32_t, uint8_t, StMPXCANLog**, uint16_t*, uint8_t*) | MPXGetLog(uint32_t, uint8_t, StMPXLog**, uint16_t*, uint8_t*) | 第3引数型変更 |
CAN/CAN FD API
| ADL1L | ADL2L | 互換性影響 |
|---|---|---|
MPXSetCANParam | MPXCANSetParam | API名変更 |
MPXGetLogEx | MPXCANGetLogEx | API名変更 |
MPXSetSlot | MPXCANSetSlot | API名変更 |
MPXChangeSlot | MPXCANChangeSlot | API名変更 |
MPXSendSlot | MPXCANSendSlot | API名変更 |
MPXDirectSend | MPXCANDirectSend | API名変更 |
定数・構造体の移行ポイント
動作モード定数(名称変更)
| ADL1L | ADL2L | 値 |
|---|---|---|
MPX_MODE_LISTEN | MPX_CAN_MODE_LISTEN | 0 |
MPX_MODE_MONITOR | MPX_CAN_MODE_MONITOR | 1 |
MPX_MODE_CAN_SIM | MPX_CAN_MODE_SIM | 2 |
MPX_MODE_NONE | MPX_CAN_MODE_NONE | 0xFF |
値は同じですが、旧定数名は ADL2L ヘッダに存在しません。
CANエラー定数(名称変更)
エラーフラグ
| ADL1L | ADL2L | 値 |
|---|---|---|
CAN_ERRFLG_FALSE | MPX_CAN_ERRFLG_FALSE | 0 |
CAN_ERRFLG_TRUE | MPX_CAN_ERRFLG_TRUE | 1 |
エラー詳細
| ADL1L | ADL2L | 値 |
|---|---|---|
CAN_ERR_NONE | MPX_CAN_ERR_NONE | 0x0000 |
CAN_ERR_BUS | MPX_CAN_ERR_BUS | 0x0001 |
CAN_ERR_WARN | MPX_CAN_ERR_WARN | 0x0002 |
CAN_ERR_PASV | MPX_CAN_ERR_PASV | 0x0004 |
CAN_ERR_BUSOFF | MPX_CAN_ERR_BUSOFF | 0x0008 |
CAN_ERR_BUSWAKE | MPX_CAN_ERR_BUSWAKE | 0x0010 |
CAN_ERR_OVERLOAD | MPX_CAN_ERR_OVERLOAD | 0x0020 |
CAN_ERR_BUSLOCK | MPX_CAN_ERR_BUSLOCK | 0x0040 |
CAN_ERR_ARBLOST | MPX_CAN_ERR_ARBLOST | 0x0080 |
CAN_ERR_STAFF | MPX_CAN_ERR_STAFF | 0x0100 |
CAN_ERR_FORM | MPX_CAN_ERR_FORM | 0x0200 |
CAN_ERR_ACK | MPX_CAN_ERR_ACK | 0x0400 |
CAN_ERR_CRC | MPX_CAN_ERR_CRC | 0x0800 |
CAN_ERR_RECEIVE | MPX_CAN_ERR_RECEIVE | 0x1000 |
CAN_ERR_DOMINANT | MPX_CAN_ERR_DOMINANT | 0x2000 |
CAN_ERR_DELIMITER | MPX_CAN_ERR_DELIMITER | 0x4000 |
変更なしの主要定数
以下は ADL1L と ADL2L で同一定義です。
MPX_CAN_PARAM_ABR_*MPX_CAN_PARAM_SP_*MPX_CAN_PARAM_DBR_*MPX_CAN_FRAME_TYPE_*MPX_CAN_SLOT_*MPX_CAN_PROTOCOL_*MPX_CAN_BRS_*MPX_CAN_IDE_*MPX_CAN_RTR_*MPX_CAN_SIM_INC_*
CAN構造体の互換性
CAN関連構造体は ADL1L と ADL2L で互換です(名称・レイアウトとも同一)。
StMPXCANParamStMPXCANIDStMPXCANFrameOptionStMPXCANFrameTypeStMPXCANFrameStMPXCANSlotStMPXCANDirectStMPXCANLog
MPXGetLog の型変更
MPXGetLog は関数名が同じでも、受け取り型が変わっています。
- ADL1L:
StMPXCANLog** - ADL2L:
StMPXLog**
移行時は次のいずれかで対応してください。
MPXCANGetLogExへ統一する(推奨)MPXGetLogを継続利用し、StMPXLogからMisc.CANを参照する
戻り値(ER)差分
ERコードは ADL1L と ADL2L で同一です。
| 定数 | 値 |
|---|---|
E_OK | 0 |
E_PARAM | 1 |
E_DEVICE | 2 |
E_COMM | 3 |
E_TGT | 4 |
E_TRG_BUSY | 11 |
E_DCT_FULL | 12 |
E_STATUS | 105 |
E_TIMEOUT | 202 |
E_OTHER | 255 |
実装手順(既存アプリ置換フロー)
- DLL参照名を
MPXCANFDCtrlFree*からMPXCtrlFree*へ変更 MPXOpen呼び出しを3引数版へ修正- CAN API名を
MPXCAN*へ置換 MPX_MODE_*とCAN_ERR*を新定数へ置換- ログ取得を
MPXCANGetLogEx中心に統一(またはMPXGetLog型変更対応)
言語別 置換例
C/C++ 置換例
// ADL1L
StMPXDeviceInfo devs[8] = {};
uint8_t count = 0;
ER er = MPXOpen(devs, &count);
uint32_t serial = (count > 0) ? devs[0].Serial : 0;
er = MPXSetCANParam(serial, innerCh, ¶m);
er = MPXGetLogEx(serial, innerCh, logs, num, &got, &over);
// ADL2L
StMPXDeviceInfo devs[8] = {};
uint8_t count = 0;
ER er = MPXOpen(devs, 8, &count);
uint32_t serial = (count > 0) ? devs[0].Serial : 0;
er = MPXCANSetParam(serial, innerCh, ¶m);
er = MPXCANGetLogEx(serial, innerCh, logs, num, &got, &over);
C/C++ CAN/CAN FDシミュレーション置換例
// ADL1L
param.Mode = MPX_MODE_CAN_SIM;
MPXSetCANParam(serial, innerCh, ¶m);
MPXSetSlot(serial, innerCh, slots, 2);
MPXMonitorStart(serial, MPX_SYNC_MASTER);
// ADL2L
param.Mode = MPX_CAN_MODE_SIM;
MPXCANSetParam(serial, innerCh, ¶m);
MPXCANSetSlot(serial, innerCh, slots, 2);
MPXMonitorStart(serial, MPX_SYNC_MASTER);
差分の大きいAPIの置換指針
MPXGetLog 継続利用時の注意
ADL2Lの MPXGetLog は StMPXLog** を返します。
CANログへアクセスする場合は Misc.CAN を参照してください。
ログ取得は MPXCANGetLogEx への統一を推奨
既存の MPXGetLogEx 利用コードは、API名置換のみで移行できるため、MPXCANGetLogEx への統一が最も安全です。
移行チェックリスト
- DLL名を
MPXCANFDCtrlFree*からMPXCtrlFree*に変更した -
MPXOpenを3引数版へ修正した -
MPXSetCANParamなどCAN APIをMPXCAN*へ置換した -
MPX_MODE_*をMPX_CAN_MODE_*へ置換した -
CAN_ERR*/CAN_ERRFLG_*をMPX_CAN_ERR*/MPX_CAN_ERRFLG_*へ置換した -
MPXGetLogExをMPXCANGetLogExへ置換した -
MPXGetLogを使う場合はStMPXLog**へ型変更した - 置換後に Open/Param/Monitor/Slot/GetLog の基本動作を確認した
関連ページ
- 共通 API 一覧: /S810-MX-ADL2L/Common/api_list_common
- 共通 API 詳細: /S810-MX-ADL2L/Common/api_detail_common
- CAN API 一覧: /S810-MX-ADL2L/CAN/api_list_can
- CAN API 詳細: /S810-MX-ADL2L/CAN/api_detail_can
- CAN 構造体定義: /S810-MX-ADL2L/CAN/struct_can