投稿日:

Haskellメモ　というか，High Sierra と FTDI USB Serial メモ

以前からぼちぼち開発しているRoverMiniコンピュータデータ取扱用のプログラム，ので本日はその原因究明と対策実施。

現象

  • macOS X を High Sierra にしたら，FTDIのUSBシリアル変換機がマック上ではttyデバイスとして認識されなくなった。
  • 同じハードで仮想マシン上のWindows10では同変換器を検出し，正常にECUと通信できるので，マック上のドライバの問題と想定。
  • メーカー（FTDI社）の最新ドライバなどをインストールしてみたが，状況は変わらなかった。
  • High Sierra ではセキュリティ強化のため，場合によっては「システム環境設定」のセキュリティとプライバシー設定で，明示的に権限許可を与えないと動作しない機能拡張があるが，現時点では許可催促の表示は出ていない（ただし，当該催促は最初にその機能拡張が動作しようとしてから一定の時間以内にのみ表示され，その後は消えてしまうとのことなので，OSアップデート後にケーブルを初めて挿入した際，これを見逃した可能性はある）。

原因探索

ネットで検索した所，以下のことがわかり，ドライバが複数あって，衝突して不具合となっている可能性があるものと思われた。

  • Appleは，しばらく前（少なくとも Marverics )から，自社のFTDIチップ用ドライバを mac OS に含めて提供している。
  • 幾つかのサイトでは，FTDI社のドライバとApple社のドライバの切り替えを行って問題が解決したことを報告している。（例１，例２，例３，例４）
  • 両ドライバとも，kext形式で提供されている。
  • kextとは，加除可能なOS機能追加モジュールであり，sudo kextstatで現在使われているモジュールの確認ができる他，sudo kextload xx.kext でモジュールを追加することができる。
  • 当該ハードには，OSバージョンアップ前からFTDI社のドライバが入れてあり，機能していたが，こうした場合，High Sierraのインストールでは，（クリーンインストールであっても？）サードパーティー提供のドライバが新たな権限許可を与えずとも動作するようになっている模様。

対策

ドライバを一つにする。Apple社提供のものでまずは実験してみて，その上で，FTDI社のものを実験してみるかを判断することにした。実際の作業としては，以下の通り。

  • 存在しているドライバの確認。→/System/Library/Extentions にAppleUSBFTDI.kext 2017/08/25 14:20 6.0.0 がある。また，Library/Extentions に FTDI社のドライバ D2xxHelper.kext 2015/11/09 2.0.0 があった。
  • kextstat | grep FTDI で動作している機能拡張を確認。今回の場合はなかった（両方共読み込み失敗の様子）。
  • FTDI社のドライバを削除の上，マックを再起動。
  • 手動でAppleのドライバを読み込み（cd /System/Library/Extentions  -> sudo kextload AppleUSBFTDI.kext)
  • kextstat で機能拡張が読み込まれているかを確認。この時点では読み込まれていない。
  • ケーブルを接続。kextstatで状況確認→ドライバが読み込まれている。
  • /dev/ を確認。無事，認識され，/dev/tty.usbserial-DJ0… として表示された。

まとめ

  • 今回のトラブルの原因は複数の機能拡張（ドライバ）を設置したことによる競合。
  • 純正とメーカー製の二種類のドライバで機能・性能が違いそうなので，今後，機能・性能で不審な点があった場合，ドライバを変えてみるという策をとってみる必要がある。

以上

 

投稿日:

Haskellメモ　Haddock

この説明は，Haskellの公式サイトの記述を魚野が自分のメモとして部分的に日本語化したもの。
詳細は下記サイト参照。
http://haskell-haddock.readthedocs.io/en/latest/markup.html

1 Haddockとは

Haddockとは，プログラミング言語，Haskellのソースファイルにコメントを記述することで，
自動的に参考用の文書を作成するシステムのこと。

2 Haddockの記法

2-1 トップレベル宣言

・トップレベル（関数の型署名や方宣言，クラス宣言等）での記述。
・「--|」という句で書き出すと，それ以降の部分はその直後の宣言に関する説明となる。
例
-- | The 'square' function square an integer
square :: Int -> Int
square x = x * x

・トップレベルとは
トップレベルの関数の型署名
型署名のないトップレベルの関数の定義
data 宣言
newtype 宣言
type 宣言
class 宣言
data family または type family 宣言
data instance またはtype instance 宣言
・別の宣言が続いた時は，後の宣言はHaddockに無視される。
・宣言の後にコメントを書くことも可能。
例
square :: Int -> Int
-- ^ The 'square' function square an integer
square x = x * x

2-2 宣言の一部分へのコメント

・クラスメソッド トップレベル宣言に同じ（「-- |」 や「--^」を使う）。
・コンストラクタ，レコードフィールド　同上

2-3 関数の引数

・「--^」を使う。
例
f :: Int -- ^ The 'Int' argument
-> Float -- ^ the 'Float' argument
-> IO() -- ^ the return value

2-4 モジュールの説明

・モジュールの説明は記述が多岐にわたることが多い。
例
{-|
Module : W
Description : Short description
Copyright : (c) Some Guy, 2013
Someone Else, 2014
License : GPL-3
Maintainer : sample@email.com
Stability : experimental
Portability : POSIX

Here is a longer description of this module, containing some
commentary with @some markup@.
-}
・各フィールド全てを記述する必要はない。重要度の順で記述すること。
・各フィールドの中身が二行以上になる時は，フィールドのラベル終了位置よりも右方から記述する。
・但し，冒頭に「--」を記述した際は例外（詳細は冒頭のURL参照）

2−5 モジュールの説明要素

・Module モジュール名
・Description モジュールの概説。
・Copyright, License, Maintainer, Stability できるだけ明示すること
・Portability OSの制約や必要なGHC拡張が記述されることが多い。

3 ドキュメントの構造

・各モジュールが輸出（エクスポート）している要素のみ説明文作成の対象とされる。
・輸入（インポート）されたモジュールで輸出されている場合も説明文作成の対象となる。
・３つの構造がある：セクション頭書，名前付記述，モジュール全体の再輸出

3-1 セクション頭書

・Class, Typeなどは同位のセクション，Type, A data type などはセクションの下位化
・「-- *」，「-- **」などで書き始める。*数はセクションの下位化

3-2 名前付記述

・名前付記述 二個目の「-- $XXX」以降の記述は一個めの「-- $XXX」の部分に置かれる。
（XXXは名前）

3-3 ハイパーリンクと要素再輸出

・Haddockは説明文書作成の際，クラス名などを全てハイパーリンクつきにする。