================================================================================ = CORAS(LNX) = = Linux用 RASドライバ = = Ver. 1.14.1 = = CONTEC Co.,Ltd. = ================================================================================ ◆ 目次 ======= はじめに 製品概要 対象機種 制限事項 注意事項 インストール/アンインストール ファイル構成 更新履歴 ◆ はじめに =========== 日頃から格別のお引き立てを賜りまして厚く御礼申し上げます。 CORAS(LNX)に関する説明を以下に記載します。ヘルプ等に記載されていない事項も ありますので、ぜひご一読下さい。 ◆ 製品概要 =========== - CORAS(LNX)は、モジュール形式のドライバとシェアードライブラリにより、 弊社製ボードを制御するための関数群を提供しています。 - ドライバ起動スクリプトによりドライバを起動して使用します。 - サンプルソースコードが添付されています。 ◆ 対象機種 =========== - BX-220 Series *1 - BX-320 Series - BX-830 Series *1 - BX-956S Series - PT-956S Series - BX-825 Series - CPS-BXC200 Series *2 - BX-U200 Series - BX-T1000 Series *1 - BX-T210 Series - PT-V10/15WB-2x0 Series *3 - BX-M1500 Series - BX-M2500 Series - BX-T3000 Series - PT-M1xSA-210 Series - BX-T310-J Series - BX-M310-J Series - PT-M07WA-310/PT-F10SA-320/PT-F12SA-320 Series - BX-U310 series *1) BX-220 Series, BX-830 Series, BX-T1000 Seriesにおいて、すべての機能を利用 するためには、Linux kernelの再構築が必要です。詳細については、Linux動作確認書 の内容をご確認ください。また、インストール前にあらかじめi2c-devなど必要な モジュールのロードを行うように設定したうえで、ユーティリティのプログラムコード 内のbus番号について適宜変更ください。 *2) CPS-BXC200 Seriesについて、弊社DIOドライバによる本体DIO操作と本RASドライバ でのWDTの操作を併用される場合は、それぞれ適切に排他制御する必要がございますの でご注意ください。それぞれの操作を排他制御しない場合は、意図しない問題が生じる 場合があります。 *3) PT-V10/15WB-2x0 Seriesにおけるバックライト制御に関して 標準状態でACPI(acpi_video)を通じた本体LCDの輝度制御が可能ですが、本ユーティリ ティソフトウェアを利用される場合はACPIを通じた輝度制御とは併用いただけません。 "/sys/class/backlight/acpi_video0"からのバックライト制御と併用した場合は意図し ない動作が発生する場合があります。 本ユーティリティソフトウェア利用時には、ドライバモジュール(coras)にて提供され るLCDバックライト制御を利用してください。利用の際は事前にカーネルオプションに "acpi_backlight=vendor"を追加する必要があります。また、corasドライバモジュール がロードされている状態で、"/sys/class/backlight/contec_backlight"の ディレクトリが存在することを確認し、同ディレクトリ下の"brightness"への数値の 入力や、デスクトップ環境上から操作を行い、輝度が変更できることをご確認くださ い。"brightness" への入力範囲は0-"max_brightness"の範囲で行えます。 輝度値 0 はバックライトが完全に消灯しない設定範囲の下限値です。LCDバックライト をOS側の制御に依らずON/OFFする場合は、"bl_power" に 4 (FB_BLANK_POWERDOWN)を 入力することで消灯、0 (4以外)を入力すると点灯の操作が行えます。 輝度値のOSシャットダウン時の設定保存と起動時の復元については、coras_load serviceから実行されます。 ◆ 制限事項 =========== 動作確認環境については以下の通りです。下記記載については、従来バージョンでの 確認情報と合わせて記載している場合があります。本バージョンと全ての対象機種や 記載のディストリビューション(及びバージョン)との全ての組み合わせで改めて実行 確認を行っているものでは無いことを予めご了承ください。また、記載の全ての機種と 各ディストリビューション(及びバージョン)との組み合わせでの動作を保証するもの ではありません。 * 下記記載の内容はリリース時点の内容です。各ディストリビューションのサポート 状況とそぐわない場合がございます。 * 個別の機種に対するLinux OSの動作確認情報については、各機種の動作確認書の内容 をご確認ください。 ディストリビューション カーネルバージョン ---------------------- ------------------ Ubuntu Ubuntu 20.04 LTS 5.4.0-26-generic(x86_64) 5.8.0-43-generic(x86_64)(hwe) 5.11.0-27-generic(x86_64)(hwe) 5.13.0-30-generic(x86_64)(hwe) 5.15.0-67-generic(x86_64)(hwe) Ubuntu 22.04 LTS 5.15.0-25-generic(x86_64) 6.2.0-26-generic(x86_64)(hwe) 6.8.0-40-generic(x86_64)(hwe) Ubuntu 24.04 LTS 6.8.0-41-generic(x86_64) Red Hat Enterprise Linux(RHEL) RHEL 7.9 3.10.0-1160.el7.x86_64 RHEL 8.3 4.18.0-240.el8.x86_64 RHEL 8.4 4.18.0-305.el8.x86_64 RHEL 8.6 4.18.0-372.9.1.el8.x86_64 RHEL 8.9 4.18.0-513.5.1.el8_9.x86_64 RHEL 8.10 4.18.0-553.el8_10.x86_64 RHEL 9.0 5.14.0-70.13.1.el9_0.x86_64 RHEL 9.3 5.14.0-362.8.1.el9_3.x86_64 RHEL 9.4 5.14.0-427.13.1.el9_4.x86_64 RHEL 9.5 5.14.0-503.11.1.el9_5.x86_64 MIRACLE LINUX(ML) ML 8.4 4.18.0-305.el8.x86_64 ML 8.6 4.18.0-372.9.1.el8.x86_64 ML 8.8 4.18.0-477.10.1.el8_8.x86_64 ML 8.10 4.18.0-553.el8_10.x86_64 ML 9.0 5.14.0-70.13.1.el9_0.x86_64 ML 9.2 5.14.0-284.11.1.el9_2.x86_64 ML 9.4 5.14.0-427.13.1.el9_4.x86_64 dependencies ------------ - glibc ≧ 2.17 - gcc - GNU make - systemd etc. ◆ 注意事項 ========== - 本ソフトウェアパッケージに含まれるドライバソース及びライブラリ等の使用にあ たっては、添付のEULAの内容をご確認頂き、使用条件をご承諾の上ご利用ください。 - ドライバのインストールおよび設定、起動、makeの実行などはroot権限で行う必要が あります。その他、パーミッションの設定やセキュリティ設定など、ご利用の環境に より、動作等に制約が生じる場合がございます。 - カーネルを更新された場合等、必要に応じて本カーネルモジュールの再構築が必要 になる場合があります。 - 詳細についてはhelpドキュメント及び各スクリプト、プログラムソースなどの内容を 参照ください。 ◆ インストール/アンインストール ================================ [src package] - install モジュール、ライブラリ等のコンパイル及びインストール処理を行います。 # cd ./(CORASLNX_Top_Directory) # make install - uninstall モジュール、ライブラリ等のアンインストール処理を行います。 # cd ./(CORASLNX_Top_Directory) # make uninstall * インストール先の変更など行っている場合はアンインストール処理が適切に行われ ない場合があります。また、アンインストール時にインストール時に使用したもの と異なるバージョンのものを使用した場合は正常に処理されない場合があります。 * makefile 実行オプション 以下の実行オプションがあります。必要に応じてご活用ください。 install .. module、library関連(header含む開発環境)のインストール uninstall .. module、library関連のアンインストール install_all .. module、library関連、各種サンプルプログラム(温度監視 デーモン)のインストール、コンソールサンプルのビルド uninstall_all .. module、library関連、各種サンプルプログラム(温度監視 デーモン)のアンインストール、コンソールサンプルのクリーン install_util .. 各種サンプルプログラム(温度監視デーモン)のインストール (事前にmodule、library関連のインストールが必要です。) uninstall_util .. 各種サンプルプログラム(温度監視デーモン)のアンインストール sample .. 機器に対応しているコンソールサンプルのビルド (注 : dmi情報で判定するため、一部機種では非対応のものも含め ビルドされる場合があります。) clean .. install、sampleオプション時に作成された中間ファイル、 実行ファイル等の削除 * 個別にコンパイル、インストールを行う場合は、helpドキュメントの内容や、 各makefileの内容などを参照の上、インストール順等をご確認のうえ実施ください。 * RHEL系の場合、SELinuxによりドライバモジュールが正常にロードされない場合があり ます。corasモジュールのロードがSELinuxで制限されている場合はポリシーを適切に 設定するなどの変更が必要です。以下はポリシーの設定例です。 (インストール後に実行) 作業ディレクトを作成し、移動 # mkdir (work_dir) && cd ./(work_dir) ポリシーパッケージを生成 # ausearch -c 'insmod' -f '/opt/contec/CoRasMod/coras.ko' --raw | \ audit2allow -M coras-insmod ポリシーパッケージを有効化 # semodule -i coras-insmod.pp ポリシーパッケージの有効化を確認 # semanage module -l | grep coras-insmod 再起動を行いcorasモジュールが正常にロードされることを確認します。 必要に応じて、corasモジュールは再ロードしてください。 # systemctl restart coras_load.service [rpm package] 同梱のRPMパッケージは、RHEL及びML等のRHEL互換の環境で利用いただける場合がありま す。以下、dnfコマンドを使用した場合の例です。 - install # cd ./(CORASLNX_Top_Directory)/rpm/elX/ パッケージインストール # dnf install \ ./kmod-coras.X.X-X.elX..rpm \ ./coras-X.X-X.elX..rpm \ ./coras-tools-X.X-X.elX..rpm \ ./coras-devel-X.X-X.elX..rpm corasモジュール初期化処理 (初期化サービスの実行 または 再起動) # systemctl start coras_load CUI toolの実行テスト(温度情報の取得) # corasctl temp * kmodパッケージはkABI-tracking kmod形式です。実行環境に応じたパッケージを インストールしてください((例)el9.1のカーネル環境の場合は162.6.1.el9_1の パッケージ、等)。対応するkmodのカーネルモジュールパッケージをインストール 後に、カーネルを新しいelマイナーリリースのものにアップデートした場合、カー ネルABIの変更により、kmodパッケージのカーネルモジュールが機能しなくなる 場合があります。アップグレード時には、kmod-corasパッケージが適切なカーネル モジュールを提供していることを確認し、kmod-corasパッケージを更新、再インス トールする必要があります。 - uninstall パッケージアンインストール # dnf remove kmod-coras coras coras-tools coras-devel [deb package] Ubuntu及び互換性のある環境で利用可能な場合があります。 以下、aptコマンドを利用してローカルインストールする場合の例です。 - install # cd ./(CORASLNX_Top_Directory)/debs// パッケージインストール # apt install \ ./coras-dkms_X.XX-XubuntuX_.deb \ ./coras_X.XX-XubuntuX_.deb \ ./coras-tools_X.XX-XubuntuX_.deb \ ./coras-dev_X.XX-XubuntuX_.deb CUI toolの実行テスト(温度情報の取得) # corasctl temp * coras-dkmsはdkmsを使用します。dkmsおよび依存パッケージのインストールが必要 になります。カーネルパッケージ更新時は対象のカーネルに対してdkmsにより 当モジュールのリビルドが試みられます。 - uninstall パッケージアンインストール # apt purge coras-dkms coras coras-tools coras-dev [note] * PT-V10/15WB-2x0 Seriesの場合 カーネルオプションに"acpi_backlight=vendor"を必ず追加してください。 * 温度監視デーモンサンプルの設定値は初期値が機種にかかわらず一律の値が設定 されておりますので、ご利用の際は適宜設定を変更してください。 * サンプルユーティリティ(cuiツールサンプル, 温度監視デーモンサンプル) cuiツールサンプル(corasctl)、温度監視デーモンサンプル(cohwmond)では、 libudev.h又はsd-device.hを利用します。以下の依存パッケージ等が必要になります。 - ubuntu 20.04、ubuntu 22.04、ubuntu 24.04 libsystemd-dev - RHEL7、RHEL8、RHEL9、ML8、ML9 systemd-devel ◆ ファイル構成 ============================ 構成は以下のようになります。 ./(CORASLNX_Top_Directory)/ readme_j.txt .......... READMEファイル 日本語版 readme_e.txt .......... READMEファイル 英語版 EULA_JP.txt ........... 使用許諾契約書 日本語版 EULA_EN.txt ........... 使用許諾契約書 英語版 Makefile .............. コンパイル、インストールの一括処理用メイクファイル help/ ................. helpファイル格納ディレクトリ jp/ ................. 日本語版 corashelp.htm ..... htmlヘルプファイル data/ ............. ヘルプデータ en/ ................. 英語版 corashelp.htm ..... htmlヘルプファイル data/ ............. ヘルプデータ module/ ............... coras driver module library/ include/ coras_lib.h ....... ライブラリヘッダーファイル coras_ctl.h ....... ライブラリ/ドライバ共通ヘッダーファイル mtdll.h ........... ライブラリ/ドライバ共通ヘッダーファイル x86_64/ ............. 64ビットシェアードライブラリ libcoraslib.so.x.x libmtdll.so.x.x Makefile ............ ライブラリインストール用メイクファイル samples/ corasctl/ ........... sample cui tool cohwmond/ ........... ハードウェア(温度)モニターデーモンサンプル console_samples/ .... コンソール実行用のサンプルソースコード格納先 bin/ .............. sample実行ファイルのビルド後格納先 dio/ .............. 汎用入出力のコンソールサンプル hwmon/ ............ ハードウェアモニタのコンソールサンプル PMonitor/ ......... 温度監視を行うコンソールサンプル RS485/ ............ RS485通信モード制御サンプル Serial/ ........... RS-422/485の通信サンプル sled/ ............. ステータスLEDの制御サンプル uSW/ .............. ユーザースイッチの状態取得サンプル wdt/ .............. ウォッチドッグタイマー制御サンプル old_samples/ ........ 旧サンプルプログラム cothermald/ ....... [obsolete] 温度監視デーモンサンプル (before v1.10) CorasGuiUtil/ ..... [obsolete] CORAS GUI Utility sample (before v1.10) rpms/ ................. rpm packages el8/x86_64/ ......... for el8 - x86_64 el9/x86_64/ ......... for el9 - x86_64 [rpm packages] kmod-coras ........ kmod kernel module packages (kABI-tracking kmod) coras ............. coras package(module init service and libs) coras-devel ....... for development sub-package(header, etc.) coras-tools ....... sample tools sub-package (daemon and cui tools) * about rpm file name --[.]...rpm pkg_name : package name (coras, coras-devel, etc.) pkg_ver : package version pkg_rel : package release (rpm package) extra_ver : extra version info (kmod-coras : additional kernel information at build) [el8] 80 : el 8.0 147 : el 8.1 - 8.2 240 : el 8.3 - 8.4 348 : el 8.5 372.9.1 : el 8.6 - 8.7 477.10.1 : el 8.8 - 8.10 [el9] 70.13.1 : el 9.0 162.6.1 : el 9.1 284.11.1 : el 9.2 362.8.1 : el 9.3 427.13.1 : el 9.4 503.11.1 : el 9.5 dist : elX(_X) arch : x86_64 debs/ ................. deb packages jammy/x86_64/ ....... for 22.04(.X) LTS (Jammy Jellyfish) x86_64 noble/x86_64/ ....... for 24.04(.X) LTS (Noble Numbat) x86_64 [deb packages] coras-dkms ........ kernel module packages (dkms) coras ............. coras package(module init service and libs) coras-dev ......... for development sub-package(header, etc.) coras-tools ....... sample tools sub-package (daemon and cui tools) * about deb file name _[-revision]_.rpm pkg_name : package name (coras, coras-devel, etc.) pkg_ver : package version revision : debian revision arch : amd64 ◆ 更新履歴 ====================== Ver. 1.14.1 (Jul. 2025) ----------------------------- - bugfix : BX-U310を除く機種で、下記の関数の実行時に意図しない戻り値 (INVALID_CALL(0x20001003))が返される問題を修正。 - MT_StartWDT - MT_StopWDT - MT_SetWDT - MT_TickWDT Ver. 1.14 (Dec. 2024) ----------------------------- - 対象機種の追加(BX-U310 Series) - 同梱するdeb packageに関する更新 - ubuntu 18.04(.x) LTS (Focal Fossa)向けを廃止 - ubuntu 24.04(.x) LTS (Noble Numbat)向けを追加 - 対象ディストリビューションの更新 - CentOS 7 をEOLに伴い削除 etc. Ver. 1.13 (May 2024) ----------------------------- - 対象機種の追加(PT-M07WA-310/PT-F10SA-320/PT-F12SA-320 Series) Ver. 1.12 (Mar. 2024) ----------------------------- - 対象機種の追加(BX-T310-J, BX-M310-J) Ver. 1.11 (Jan. 2024) ----------------------------- - バイナリパッケージ(rpm, deb)を追加 - add rpm packages for - el8 - el9 - add deb packages for - Ubuntu 20.04 LTS (Focal Fossa) - Ubuntu 22.04 LTS (Jammy Jellyfish) - cuiツールサンプル(corasctl)を追加 - 温度監視デーモンサンプルをcothermald -> cohwmondへ移行。 旧温度監視デーモンサンプル(cothermald)のステータスを廃止へ移行。 - サンプルGUIをGTK+3向けに一部更新。 サンプルGUIのステータスを廃止へ移行。 - 確認情報、ドキュメントの更新 Ver. 1.10 (Sep. 2022) ----------------------------- - 対象機種の追加(PT-M1xSA-210) Ver. 1.09 (May. 2022) ----------------------------- - 対象機種の追加(BX-T3000) - 確認情報の更新 Ver. 1.08 (Dec. 2021) ----------------------------- - 対象機種の追加(BX-M2500) Ver. 1.07 (Oct. 2021) ----------------------------- - 対象機種の追加(BX-M1500) - EULAの一部改訂 Ver. 1.06 (Aug. 2021) ----------------------------- - 対象機種の追加(PT-V10WB) - PT-V10WB Seriesのバックライト操作に係わる機能の拡張 - 確認情報の更新 Ver. 1.05 (Apr. 2021) ----------------------------- - 対象機種の追加(BX-T210) - 電圧取得関数の修正(BX-T1000) - 確認情報の更新 - 軽微な修正(一部コードの修正他) Ver. 1.04 (Oct. 2020) ----------------------------- - 対象機種の追加(BX-T1000) Ver. 1.03 (Jul. 2020) ----------------------------- - 対象機種の追加(BX-U200)、確認情報の更新 - coras_shmtxの削除 - 軽微な修正(一部コードの修正他) Ver. 1.02 (May. 2020) ----------------------------- - 対象機種の追加(CPS-BXC200)、確認情報の更新 - 軽微な修正(一部ディレクトリ構成の変更他) Ver. 1.01 (Oct. 2019) ----------------------------- - GUIユーティリティサンプルの追加 - 温度監視デーモンサンプルの追加 - 対象機種の追加(BX-825) - MT_StartMonitoringEx関数の追加 - ライブラリの一部仕様変更 Ver. 1.00 (Feb. 2018) ----------------------------- - First Release <<------------------------------------------------------------------------------ Linux®は、米国およびその他の国におけるLinus Torvalds氏の登録商標です。 Ubuntuは、Canonical Ltd.の商標または登録商標です。CentOS、Red Hat、および Red Hat Enterprise Linuxは、米国およびその他の国におけるRed Hat, Inc.の 登録商標です。MIRACLE LINUX、ミラクル・リナックスは、サイバートラスト株式会社 の登録商標です。その他、本書を含むドキュメント等に記載の会社名、製品名および サービス名などは一般に各社または各団体の登録商標または商標です。 ------------------------------------------------------------------------------>>