picoxライブラリのコンパイル時コンフィギュレーション [詳解]

マクロ定義
#define	X_BYTE_ORDER_BIG (1)

#define	X_BYTE_ORDER_LITTLE (0)

#define	X_BYTE_ORDER_UNKNOWN (2)

#define	X_CONF_ASSERT(expr) X_DEFAULT_ASSERT(expr)
	X_ASSERT()を置き換えるルーチンを設定します。

#define	X_CONF_BYTE_ORDER X_BYTE_ORDER_UNKNOWN
	CPUのバイトオーダーを指定します。 [詳解]

#define	X_CONF_ERR_HEADER "[ERR ]"
	ERRORレベルのログヘッダ文字列を指定します。

#define	X_CONF_FILE_NAME_MAX (32)
	NULL終端を含むファイル名の最大バイト数を指定します [詳解]

#define	X_CONF_FILE_PATH_MAX (128)
	NULL終端を含むファイルパスの最大バイト数を指定します [詳解]

#define	X_CONF_FREE(ptr) free(ptr)
	メモリ解放関数を設定します。未指定時はfree()が使用されます。

#define	X_CONF_GETTIMEOFDAY_IMPL_TYPE X_GETTIMEOFDAY_IMPL_TYPE_ZERO
	x_port_gettimeofday()の実装方法を設定します [詳解]

#define	X_CONF_HAS_C99_MATH (0)
	strtof()等のC99で追加されたfloat版の標準関数を使用します。

#define	X_CONF_INFO_HEADER "[INFO]"
	INFOMATONレベルのログヘッダ文字列を指定します。

#define	X_CONF_LINE_MAX (128)
	1行のNULL終端を含む最大文字数を指定します [詳解]

#define	X_CONF_LOG_LEVEL X_LOG_LEVEL_INFO
	ログ出力レベルを設定します。 [詳解]

#define	X_CONF_LOG_TIMESTAMP_BUF_SIZE (32)
	タイムスタンプ文字列('\0'含む)の最大値を指定します [詳解]

#define	X_CONF_MALLOC(size) malloc(size)
	動的メモリ確保関数を設定します。未指定時はmalloc()が使用されます。

#define	X_CONF_MDELAY_IMPL_TYPE X_MDELAY_IMPL_TYPE_TICKS_BUSYWAIT
	x_port_mdelay()の実装方法を設定します [詳解]

#define	X_CONF_MSLEEP_IMPL_TYPE X_MSLEEP_IMPL_TYPE_MDELAY
	x_port_msleep()の実装方法を設定します [詳解]

#define	X_CONF_NDEBUG (0)
	アサートによる実行時チェックルーチンをコンパイル時に除去します。

#define	X_CONF_NOTI_HEADER "[NOTI]"
	NOTICEレベルのログヘッダ文字列を指定します。

#define	X_CONF_TICKS_NOW_IMPL_TYPE X_TICKS_NOW_IMPL_TYPE_GETTIMEOFDAY
	x_port_ticks_now()の実装方法を設定します [詳解]

#define	X_CONF_TICKS_PER_SEC 1000
	1秒あたりのチック数を設定します

#define	X_CONF_UDELAY_IMPL_TYPE X_UDELAY_IMPL_TYPE_TICKS_BUSYWAIT
	x_port_udelay()の実装方法を設定します [詳解]

#define	X_CONF_USE_ANSI_COLOR_LOG (1)
	ログ出力時に、各レベルに応じて色をつけます。 [詳解]

#define	X_CONF_USE_ASSERT_ARG (1)
	引数の範囲チェック等の有効化

#define	X_CONF_USE_ASSERT_ENUM (1)
	列挙値チェックの有効化

#define	X_CONF_USE_ASSERT_NULL (1)
	引数のNULLチェックの有効化

#define	X_CONF_USE_ASSERT_SELF (1)
	クラス指向モジュールの第一引数のNULLチェックの有効化

#define	X_CONF_USE_ASSERT_TAG (1)
	タグチェックの有効化

#define	X_CONF_USE_DETECT_MALLOC_NULL (0)
	picoxライブラリで何らかの動的メモリ確保失敗をX_ASSERT()で検出します。 [詳解]

#define	X_CONF_USE_DYNAMIC_LOG_SUPPRESS (0)
	ログ出力レベルの実行時変更機能を使用します。 [詳解]

#define	X_CONF_USE_FLOATING_POINT_PRINTF (0)
	x_printf系統の関数でfによる浮動小数点出力を使用可能にします。

#define	X_CONF_USE_LOG_TIMESTAMP (0)
	ログ出力に任意のタイムスタンプを付加します。 [詳解]

#define	X_CONF_USE_USER_CONFIG (0)
	カスタムコンフィギュレーションを定義したヘッダファイルをincludeするかどうかを指定します [詳解]

#define	X_CONF_USLEEP_IMPL_TYPE X_USLEEP_IMPL_TYPE_UDELAY
	x_port_usleep()の実装方法を設定します [詳解]

#define	X_CONF_VERB_HEADER "[VERB]"
	VERBOSEレベルのログヘッダ文字列を指定します。

#define	X_CONF_WARN_HEADER "[WARN]"
	WARNINGレベルのログヘッダ文字列を指定します。

#define	X_CONF_XFS_TYPE X_XFS_TYPE_UNION_FS
	標準のファイルシステムタイプを指定します [詳解]

#define	X_GETTIMEOFDAY_IMPL_TYPE_POSIX (2)

#define	X_GETTIMEOFDAY_IMPL_TYPE_USERPORT (1)

#define	X_GETTIMEOFDAY_IMPL_TYPE_ZERO (0)

#define	X_MDELAY_IMPL_TYPE_POSIX_NANOSLEEP (2)

#define	X_MDELAY_IMPL_TYPE_TICKS_BUSYWAIT (0)

#define	X_MDELAY_IMPL_TYPE_USERPORT (1)

#define	X_MSLEEP_IMPL_TYPE_MDELAY (0)

#define	X_MSLEEP_IMPL_TYPE_POSIX_NANOSLEEP (2)

#define	X_MSLEEP_IMPL_TYPE_USERPORT (1)

#define	X_TICKS_NOW_IMPL_TYPE_GETTIMEOFDAY (0)

#define	X_TICKS_NOW_IMPL_TYPE_USERPORT (1)

#define	X_UDELAY_IMPL_TYPE_POSIX_NANOSLEEP (2)

#define	X_UDELAY_IMPL_TYPE_TICKS_BUSYWAIT (0)

#define	X_UDELAY_IMPL_TYPE_USERPORT (1)

#define	X_USLEEP_IMPL_TYPE_POSIX_NANOSLEEP (2)

#define	X_USLEEP_IMPL_TYPE_UDELAY (0)

#define	X_USLEEP_IMPL_TYPE_USERPORT (1)

#define	X_xFS_TYPE_SINGLE_FS (1)

#define	X_XFS_TYPE_UNION_FS (0)

詳解

picoxライブラリのコンパイル時コンフィギュレーション

マクロ定義詳解

#define X_CONF_BYTE_ORDER X_BYTE_ORDER_UNKNOWN

CPUのバイトオーダーを指定します。

以下の値が指定可能です。CPUのバイトオーダーを指定していると、一部関数の実行効率が上がります。

X_BYTE_ORDER_LITTLE (リトルエンディアン)
X_BYTE_ORDER_BIG (ビッグエンディアン)
X_BYTE_ORDER_UNKNOWN (不明)

#define X_CONF_FILE_NAME_MAX (32)

NULL終端を含むファイル名の最大バイト数を指定します

X_CONF_FILE_PATH_MAXと同様に、スタックサイズに注意してください。

#define X_CONF_FILE_PATH_MAX (128)

NULL終端を含むファイルパスの最大バイト数を指定します

filesystemモジュールの関数内では、X_CONF_FILE_PATH_MAXバイトのローカル変数を多数使用するため、メモリ制約の厳しい組込みシステムではスタックサイズに注意する必要があります。

ファイル関数を使用する場合は、最低でもX_CONF_FILE_PATH_MAX * 3バイト程度のスタックを用意しておく確保しておいてください。

マルチスレッド環境ではファイル関数を呼び出すスレッドを限定しておくとメモリの節約となります。

#define X_CONF_GETTIMEOFDAY_IMPL_TYPE X_GETTIMEOFDAY_IMPL_TYPE_ZERO

x_port_gettimeofday()の実装方法を設定します

設定可能な値は以下の通りです

X_GETTIMEOFDAY_IMPL_TYPE_ZERO (default)
常に0を返すダミー実装です
X_GETTIMEOFDAY_IMPL_TYPE_USERPORT
x_port_gettimeofday()をユーザー自身が実装します
X_GETTIMEOFDAY_IMPL_TYPE_POSIX
POSIX標準のgettimeofday()を使用します

#define X_CONF_LINE_MAX (128)

1行のNULL終端を含む最大文字数を指定します

char[X_CONF_LINE_MAX]がスタックに確保される場合を考慮して適切な値を指定してください

#define X_CONF_LOG_LEVEL X_LOG_LEVEL_INFO

ログ出力レベルを設定します。

指定可能な値は以下の通りです。

X_LOG_LEVEL_VERB (優先度低)
X_LOG_LEVEL_INFO
X_LOG_LEVEL_NOTI
X_LOG_LEVEL_WARN
X_LOG_LEVEL_ERR (優先度高)

指定優先度未満のログは、X_CONF_USE_DYNAMIC_LOG_SUPPRESSが未定義であれば、コンパイル時に除去されます。

#define X_CONF_LOG_TIMESTAMP_BUF_SIZE (32)

タイムスタンプ文字列('\0'含む)の最大値を指定します

指定なしの場合は、32がデフォルト値となります。x_port_stimestamp()にはここで指定した値が渡されます。

参照: X_CONF_USE_LOG_TIMESTAMP

#define X_CONF_MDELAY_IMPL_TYPE X_MDELAY_IMPL_TYPE_TICKS_BUSYWAIT

x_port_mdelay()の実装方法を設定します

sleepよりも微小な待ち時間に対して使用することを想定しており、呼び出し側はsleepよりも精度がよいことを期待します。

設定可能な値は以下の通りです

X_MDELAY_IMPL_TYPE_TICKS_BUSYWAIT (default)
x_ticks_now()を使用したビジーウエイトで実装します
X_MDELAY_IMPL_TYPE_USERPORT
x_port_mdelay()をユーザー自身が実装します
X_MDELAY_IMPL_TYPE_POSIX_NANOSLEEP
PISIX標準のnanosleep()を使用します

#define X_CONF_MSLEEP_IMPL_TYPE X_MSLEEP_IMPL_TYPE_MDELAY

x_port_msleep()の実装方法を設定します

設定可能な値は以下の通りです

X_MSLEEP_IMPL_TYPE_MDELAY (default)
x_mdelay()を使用して実装します
X_MSLEEP_IMPL_TYPE_USERPORT
x_port_msleep()をユーザー自身が実装します
X_MSLEEP_IMPL_TYPE_POSIX_NANOSLEEP
PISIX標準のnanosleep()を使用します

#define X_CONF_TICKS_NOW_IMPL_TYPE X_TICKS_NOW_IMPL_TYPE_GETTIMEOFDAY

x_port_ticks_now()の実装方法を設定します

picox自身はチック割り込みに関与しません。ユーザーが定義したチックの周期を picoxが知るために必要な設定値です。

設定可能な値は以下の通りです

X_TICKS_NOW_IMPL_TYPE_GETTIMEOFDAY (default)
x_port_ticks_now()を、x_gettimeofday()を使用して実装します。ホスト環境でのデバッグ時や、組込みLinuxで使用する場合を想定した設定です
X_TICKS_NOW_IMPL_TYPE_USERPORT x_port_ticks_now()をユーザー自身が実装します

#define X_CONF_UDELAY_IMPL_TYPE X_UDELAY_IMPL_TYPE_TICKS_BUSYWAIT

x_port_udelay()の実装方法を設定します

x_mdelay()と同じく、x_udelay()よりも精度のよい待ちを期待します

設定可能な値は以下の通りです