汎用リングバッファ [詳解]
被依存関係図:
データ構造 | |
| struct | st_fifo |
| 汎用FIFO [詳解] | |
関数 | |
| void | init_fifo (struct st_fifo *fp, unsigned char *buf, unsigned int size) |
| fifoを初期化する [詳解] | |
| int | write_fifo (struct st_fifo *fp, unsigned char *data, unsigned int length) |
| fifoにデータを書き込む [詳解] | |
| int | read_fifo (struct st_fifo *fp, unsigned char *data, unsigned int length) |
| fifoからデータを読み出す [詳解] | |
| void | clear_fifo (struct st_fifo *fp) |
| fifoに書き込まれているデータを全て消去する [詳解] | |
| unsigned int | fifo_size (struct st_fifo *fp) |
| fifoに書き込まれているデータのサイズを返す [詳解] | |
| unsigned int | fifo_free_size (struct st_fifo *fp) |
| fifoに書き込み可能なデータのサイズを返す [詳解] | |
| int | drop_fifo (struct st_fifo *fp, unsigned int length) |
| fifoからデータを捨てる [詳解] | |
詳解
関数詳解
◆ clear_fifo()
| void clear_fifo | ( | struct st_fifo * | fp | ) |
◆ drop_fifo()
| int drop_fifo | ( | struct st_fifo * | fp, |
| unsigned int | length | ||
| ) |
fifoからデータを捨てる
- 引数
-
[in] fp データが捨てられるfifo [in] length 捨てるデータの長さ
- 戻り値
- 捨てたサイズ
◆ fifo_free_size()
| unsigned int fifo_free_size | ( | struct st_fifo * | fp | ) |
fifoに書き込み可能なデータのサイズを返す
- 引数
-
[in] fp データのサイズを読み出すfifo
- 戻り値
- fifoに書き込み可能なデータサイズ
参照先 st_fifo::rp, st_fifo::size, st_fifo::wp.
参照元 write_fifo().
被呼び出し関係図:
◆ fifo_size()
| unsigned int fifo_size | ( | struct st_fifo * | fp | ) |
fifoに書き込まれているデータのサイズを返す
- 引数
-
[in] fp データのサイズを読み出すfifo
- 戻り値
- fifoに書き込まれているデータサイズ
参照先 st_fifo::rp, st_fifo::size, st_fifo::wp.
◆ init_fifo()
| void init_fifo | ( | struct st_fifo * | fp, |
| unsigned char * | buf, | ||
| unsigned int | size | ||
| ) |
fifoを初期化する
- 引数
-
[in] fp 初期化するfifo [in] buf fifoとなるバッファポインタ [in] size バッファのバイト数
- 覚え書き
- バッファ内に保存できるデータは size-1 となる
◆ read_fifo()
| int read_fifo | ( | struct st_fifo * | fp, |
| unsigned char * | data, | ||
| unsigned int | length | ||
| ) |
fifoからデータを読み出す
- 引数
-
[in] fp データが読み出されるfifo [out] data 読み出されるデータのポインタ [in] length 読み出されるデータの長さ
- 戻り値
- 読み出しサイズ
◆ write_fifo()
| int write_fifo | ( | struct st_fifo * | fp, |
| unsigned char * | data, | ||
| unsigned int | length | ||
| ) |
fifoにデータを書き込む
- 引数
-
[in] fp データが書き込まれるfifo [in] data 書き込むデータ [in] length 書き込むデータの長さ
- 戻り値
- 書き込みサイズ
参照先 st_fifo::buf, fifo_free_size(), st_fifo::rp, st_fifo::size, st_fifo::wp.
呼び出し関係図:
