• R/O
  • HTTP
  • SSH
  • HTTPS

kz_h8write: Commit

H8/3069F writer for KOZOS - kz_h8write


Commit MetaInfo

Revisionf59f6bf2ef2f11535fb1ab01791b00140f55172d (tree)
Zeit2012-01-14 11:37:19
AutorShinichiro Nakamura <shinta.main.jp@gmai...>
CommiterShinichiro Nakamura

Log Message

コメントを修正した。 @suikan_blackfin さんに感謝。

Ändern Zusammenfassung

Diff

--- a/serial.h
+++ b/serial.h
@@ -56,10 +56,59 @@ enum SerialBaud {
5656 extern "C" {
5757 #endif
5858
59+/**
60+ * シリアルポートをオープンする.
61+ *
62+ * @param devfile シリアルポートのデバイスファイル名.
63+ * @param baud ボーレート.
64+ *
65+ * @retval !NULL ハンドラ。
66+ * @retval NULL 失敗。
67+ */
5968 SERIAL *serial_open(const char *devfile, const enum SerialBaud baud);
69+
70+/**
71+ * シリアルポートをクローズする.
72+ *
73+ * @param s シリアルデスクリプタへのポインタ.
74+ *
75+ * @return 成功したら0を返す.
76+ */
6077 int serial_close(SERIAL * s);
78+
79+/**
80+ * シリアルポートから指定バイト数の読み込みを実行する.
81+ *
82+ * @param s シリアルデスクリプタへのポインタ.
83+ * @param buf バッファへのポインタ.
84+ * @param size 読み込みバイト数.
85+ *
86+ * @return 成功したら0を返す.
87+ */
6188 int serial_read(SERIAL * s, unsigned char *buf, const size_t size);
62-int serial_read_with_timeout(SERIAL * s, unsigned char *buf, const size_t size, const int ms);
89+
90+/**
91+ * シリアルポートから指定バイト数の読み込みを実行する.
92+ *
93+ * @param s シリアルデスクリプタへのポインタ.
94+ * @param buf バッファへのポインタ.
95+ * @param size 読み込みバイト数.
96+ * @param ms ミリ秒単位のタイムアウト時間.
97+ *
98+ * @return 成功したら0を返す.
99+ */
100+int serial_read_with_timeout(
101+ SERIAL * s, unsigned char *buf, const size_t size, const int ms);
102+
103+/**
104+ * シリアルポートへ指定バイト数の書き込みを実行する.
105+ *
106+ * @param s シリアルデスクリプタへのポインタ.
107+ * @param buf バッファへのポインタ.
108+ * @param size 書き込みバイト数.
109+ *
110+ * @return 成功したら0を返す.
111+ */
63112 int serial_write(SERIAL * s, const unsigned char *buf, const size_t size);
64113
65114 #ifdef __cplusplus
--- a/serial_linux.c
+++ b/serial_linux.c
@@ -66,7 +66,8 @@ struct serial {
6666 * @param devfile シリアルポートのデバイスファイル名.
6767 * @param baud ボーレート.
6868 *
69- * @return 成功したら0を返す.
69+ * @retval !NULL ハンドラ。
70+ * @retval NULL 失敗。
7071 */
7172 SERIAL *serial_open(const char *devfile, const enum SerialBaud baud)
7273 {
--- a/serial_windows.c
+++ b/serial_windows.c
@@ -50,7 +50,8 @@ struct serial {
5050 * @param devfile シリアルポートのデバイスファイル名.
5151 * @param baud ボーレート.
5252 *
53- * @return 成功したら0を返す.
53+ * @retval !NULL ハンドラ。
54+ * @retval NULL 失敗。
5455 */
5556 SERIAL *serial_open(const char *devfile, const enum SerialBaud baud)
5657 {
Show on old repository browser