デバイスドライバAPI [詳解]

#include "task/mutex.h"

device.h の依存先関係図:

データ構造
struct	st_device
	デバイスドライバ構造体 [詳解]

マクロ定義
#define	DEF_DEV_NAME_INPUT "input"

#define	DEF_DEV_NAME_LED "led"

#define	DEF_DEV_NAME_EEPRMOM "eeprom"

#define	MAX_DEVNAMELRN 10

#define	SEEK_SET 0
	設定

#define	SEEK_CUR 1
	現在値に加算

#define	SEEK_END 2
	ファイルサイズに加算

関数
void	init_device_list (void)
	デバイスドライバリストを初期化する

int	device_num (void)
	登録されているデバイス数を取得する [詳解]

const char *	device_name (int num)
	デバイス名を取得する [詳解]

const char *	device_explan (int num)
	デバイス説明を取得する [詳解]

int	register_device (const struct st_device dev, char param)

int	unregister_device (const struct st_device *dev)
	デバイスを削除する [詳解]

int	lock_device (struct st_device *dev, unsigned int timeout)
	デバイスをロックする [詳解]

int	unlock_device (struct st_device *dev)
	デバイスをアンロックする [詳解]

struct st_device *	open_device (char *name)
	デバイスをオープンする [詳解]

int	close_device (struct st_device *dev)
	デバイスをクローズする [詳解]

int	read_device (struct st_device dev, void buf, unsigned int count)
	デバイスよりデータを読み出す [詳解]

int	getc_device (struct st_device dev, unsigned char data)
	デバイスよりデータを1バイト読み出す [詳解]

int	write_device (struct st_device dev, const void buf, unsigned int count)
	デバイスにデータを書き込む [詳解]

int	putc_device (struct st_device *dev, unsigned char data)
	デバイスにデータを1バイト書き込む [詳解]

int	ioctl_device (struct st_device dev, unsigned int com, unsigned int arg, void param)
	デバイスを制御する [詳解]

int	seek_device (struct st_device *dev, int offset, int whence)
	デバイスのアクセスポイントを設定する [詳解]

int	block_read_device (struct st_device dev, void buf, unsigned int sector, unsigned int blkcount)
	デバイスよりブロックデータを読み出す [詳解]

int	block_write_device (struct st_device dev, const void buf, unsigned int sector, unsigned int blkcount)
	デバイスにブロックデータを書き込む [詳解]

int	sync_device (struct st_device *dev)
	デバイスの書き込みデータの同期をとる [詳解]

int	select_device (struct st_device *dev, unsigned int timeout)
	デバイスのアクセス準備完了を待つ [詳解]

int	suspend_device (struct st_device *dev)
	デバイスを休止状態にする [詳解]

int	resume_device (struct st_device *dev)
	デバイスを活性化する [詳解]

int	suspend (void)
	全デバイスを休止状態にする [詳解]

int	resume (void)
	全デバイスを活性化する [詳解]

詳解

デバイスドライバAPI

日付: 2007.03.18

著者: Takashi SHUDO

device.h に定義があります。

関数詳解

◆ block_read_device()

int block_read_device	(	struct st_device *	dev,
		void *	buf,
		unsigned int	sector,
		unsigned int	blkcount
	)

デバイスよりブロックデータを読み出す

引数

[in]	dev	デバイスドライバ
[out]	buf	読み出しデータポインタ
[in]	sector	読み出しデータセクター
[in]	blkcount	読み出しデータブロック数

戻り値: 読み出しデータバイト数,<0:エラー

device.c の 410 行目に定義があります。

◆ block_write_device()

int block_write_device	(	struct st_device *	dev,
		const void *	buf,
		unsigned int	sector,
		unsigned int	blkcount
	)

デバイスにブロックデータを書き込む

引数

[in]	dev	デバイスドライバ
[in]	buf	書き込みデータポインタ
[in]	sector	書き込みデータセクター
[in]	blkcount	書き込みデータブロック数

戻り値: 書き込みデータバイト数,<0:エラー

device.c の 483 行目に定義があります。

◆ close_device()

int close_device ( struct st_device * dev )

デバイスをクローズする

引数

[in] dev デバイスドライバ

戻り値: !=0:エラー

device.c の 291 行目に定義があります。

◆ device_explan()

const char* device_explan ( int num )

デバイス説明を取得する

引数

[in] num デバイス番号

戻り値: デバイス説明

device.c の 154 行目に定義があります。

参照先 st_device::explan, flg_init_task_run, GSC_KERNEL_MAX_DEVICE_NUM.

◆ device_name()

const char* device_name ( int num )

デバイス名を取得する

引数

[in] num デバイス名

戻り値: デバイス名

device.c の 132 行目に定義があります。

参照先 GSC_KERNEL_MAX_DEVICE_NUM, st_device::name.

◆ device_num()

int device_num ( void )

登録されているデバイス数を取得する

戻り値: デバイス数

device.c の 113 行目に定義があります。

参照先 GSC_KERNEL_MAX_DEVICE_NUM.

◆ getc_device()

int getc_device	(	struct st_device *	dev,
		unsigned char *	data
	)

デバイスよりデータを1バイト読み出す

引数

[in]	dev	デバイスドライバ
[out]	data	読み出しデータポインタ

戻り値: <0:エラー

device.c の 429 行目に定義があります。

参照元 cgetc(), cgetcnw().

被呼び出し関係図:

◆ ioctl_device()

int ioctl_device	(	struct st_device *	dev,
		unsigned int	com,
		unsigned int	arg,
		void *	param
	)

デバイスを制御する

引数

[in]	dev	デバイスドライバ
[in]	com	コマンド
[in]	arg	コマンド引数

戻り値: <0:エラー

device.c の 525 行目に定義があります。

参照元 clear_screen(), draw_fill_ellipse(), get_display_frame(), get_draw_frame(), get_kernel_time(), get_system_utime(), set_display_frame(), set_draw_frame(), start_timer(), stop_timer().

被呼び出し関係図:

◆ lock_device()

int lock_device	(	struct st_device *	dev,
		unsigned int	timeout
	)

デバイスをロックする

引数

[in]	dev	デバイスドライバ
[in]	timeout	タイムアウト時間(msec)

戻り値: !=0:エラー

device.c の 310 行目に定義があります。

◆ open_device()

struct st_device* open_device ( char * name )

デバイスをオープンする

引数

[in] name デバイス名

戻り値: 0:エラー,!=0:デバイスポインタ

device.c の 262 行目に定義があります。

参照先 GSC_KERNEL_MAX_DEVICE_NUM, strcomp().

参照元 init_graphics().

呼び出し関係図:

被呼び出し関係図:

◆ putc_device()

int putc_device	(	struct st_device *	dev,
		unsigned char	data
	)

デバイスにデータを1バイト書き込む

引数

[in]	dev	デバイスドライバ
[out]	data	読み出しデータ

戻り値: <0:エラー

device.c の 502 行目に定義があります。

参照元 cputc().

被呼び出し関係図:

◆ read_device()

int read_device	(	struct st_device *	dev,
		void *	buf,
		unsigned int	count
	)

デバイスよりデータを読み出す

引数

[in]	dev	デバイスドライバ
[out]	buf	読み出しデータポインタ
[in]	count	読み出しデータバイト数

戻り値: 読み出しデータバイト数,<0:エラー

device.c の 378 行目に定義があります。

◆ resume()

int resume ( void )

全デバイスを活性化する

戻り値: <0:エラー

device.c の 655 行目に定義があります。

参照先 GSC_KERNEL_MAX_DEVICE_NUM.

◆ resume_device()

int resume_device ( struct st_device * dev )

デバイスを活性化する

引数

[in] dev デバイスドライバ

戻り値: <0:エラー

device.c の 618 行目に定義があります。

◆ seek_device()

int seek_device	(	struct st_device *	dev,
		int	offset,
		int	whence
	)

デバイスのアクセスポイントを設定する

引数

[in]	dev	デバイスドライバ
[in]	offset	オフセット
[in]	whence	オフセット開始位置

戻り値: <0:エラー

device.c の 545 行目に定義があります。

◆ select_device()

int select_device	(	struct st_device *	dev,
		unsigned int	timeout
	)

デバイスのアクセス準備完了を待つ

引数

[in]	dev	デバイスドライバ
[in]	timeout	タイムアウト時間

戻り値: <0:エラー

device.c の 582 行目に定義があります。

参照元 cgetc(), cwait().

被呼び出し関係図:

◆ suspend()

int suspend ( void )

全デバイスを休止状態にする

戻り値: <0:エラー

device.c の 634 行目に定義があります。

参照先 GSC_KERNEL_MAX_DEVICE_NUM.

◆ suspend_device()

int suspend_device ( struct st_device * dev )

デバイスを休止状態にする

引数

[in] dev デバイスドライバ

戻り値: <0:エラー

device.c の 600 行目に定義があります。

◆ sync_device()

int sync_device ( struct st_device * dev )

デバイスの書き込みデータの同期をとる

引数

[in] dev デバイスドライバ

戻り値: <0:エラー

device.c の 563 行目に定義があります。

◆ unlock_device()

int unlock_device ( struct st_device * dev )

デバイスをアンロックする

引数

[in] dev デバイスドライバ

戻り値: !=0:エラー

device.c の 343 行目に定義があります。

◆ unregister_device()

int unregister_device ( const struct st_device * dev )

デバイスを削除する

引数

[in] dev デバイスドライバ

戻り値: !=0:エラー

device.c の 225 行目に定義があります。

参照先 flg_init_task_run, GSC_KERNEL_MAX_DEVICE_NUM, st_device::mutex, mutex_unregister(), mutex_unregister_ISR().

呼び出し関係図:

◆ write_device()

int write_device	(	struct st_device *	dev,
		const void *	buf,
		unsigned int	count
	)

デバイスにデータを書き込む

引数

[in]	dev	デバイスドライバ
[in]	buf	書き込みデータポインタ
[in]	count	書き込みデータバイト数

戻り値: 書き込みデータバイト数,<0:エラー

device.c の 451 行目に定義があります。

データ構造

マクロ定義

関数

詳解

関数詳解

◆ block_read_device()

◆ block_write_device()

◆ close_device()

◆ device_explan()

◆ device_name()

◆ device_num()

◆ getc_device()

◆ ioctl_device()

◆ lock_device()

◆ open_device()

◆ putc_device()

◆ read_device()

◆ resume()

◆ resume_device()

◆ seek_device()

◆ select_device()

◆ suspend()

◆ suspend_device()

◆ sync_device()

◆ unlock_device()

◆ unregister_device()

◆ write_device()