File: serial_ctrl.h

package info (click to toggle)
urg 0.8.11-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 3,212 kB
  • ctags: 1,605
  • sloc: sh: 10,014; cpp: 6,459; ansic: 2,419; makefile: 203
file content (109 lines) | stat: -rw-r--r-- 2,027 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
#ifndef QRK_C_SERIAL_CTRL_H
#define QRK_C_SERIAL_CTRL_H

/*!
  \file
  \brief VAʐM

  Serial Communication Interface 

  \author Satofumi KAMIMURA

  $Id: serial_ctrl.h 1553 2009-11-29 15:47:05Z satofumi $
*/

#include "serial_t.h"


extern void serial_initialize(serial_t *serial);


/*!
  \brief ڑ

  \param[in,out] serial VA̍\
  \param[in] device ڑfoCX
  \param[in] baudrate ڑ{[[g

  \retval 0 
  \retval < 0 G[
*/
extern int serial_connect(serial_t *serial, const char *device, long baudrate);


/*!
  \brief ؒf

  \param[in,out] serial VA̍\
*/
extern void serial_disconnect(serial_t *serial);


/*!
  \brief ڑԂ

  \param[in] serial VA̍\

  \retval 1 ڑ
  \retval 0 ؒf
*/
extern int serial_isConnected(const serial_t *serial);


/*!
  \brief {[[g̕ύX

  \param[in,out] serial VA̍\
  \param[in] baudrate {[[g

  \retval 0 
  \retval < 0 G[
*/
extern int serial_setBaudrate(serial_t *serial, long baudrate);


/*!
  \brief M

  \param[in,out] serial VA̍\
  \param[in] data Mf[^
  \param[in] data_size MTCY

  \retval >= 0 MTCY
  \retval < 0 G[
*/
extern int serial_send(serial_t *serial, const char *data, int data_size);


/*!
  \brief M

  \param[in,out] serial VA̍\
  \param[in] data Mf[^i[obt@
  \param[in] data_size_max Mobt@̍őTCY
  \param[in] timeout ^CAEg [msec]

  \retval >= 0 MTCY
  \retval < 0 G[
*/
extern int serial_recv(serial_t *serial,
                       char *data, int data_size_max, int timeout);


/*!
  \brief MP߂

  \param[in,out] serial VA̍\
  \param[in] ch ߂P

  \attention ǂݏos킸ɁAAď߂Ă͂ȂȂ
*/
extern void serial_ungetc(serial_t *serial, char ch);


/*!
  \brief Mobt@j
*/
extern void serial_clear(serial_t* serial);

#endif /* !QRK_C_SERIAL_CTRL_H */