|
1 /****************************************************************************** |
|
2 * |
|
3 * $Id$ |
|
4 * |
|
5 * Copyright (C) 2006-2008 Florian Pose, Ingenieurgemeinschaft IgH |
|
6 * |
|
7 * This file is part of the IgH EtherCAT master userspace library. |
|
8 * |
|
9 * The IgH EtherCAT master userspace library is free software; you can |
|
10 * redistribute it and/or modify it under the terms of the GNU Lesser General |
|
11 * Public License as published by the Free Software Foundation; version 2.1 |
|
12 * of the License. |
|
13 * |
|
14 * The IgH EtherCAT master userspace library is distributed in the hope that |
|
15 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied |
|
16 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
17 * GNU Lesser General Public License for more details. |
|
18 * |
|
19 * You should have received a copy of the GNU Lesser General Public License |
|
20 * along with the IgH EtherCAT master userspace library. If not, see |
|
21 * <http://www.gnu.org/licenses/>. |
|
22 * |
|
23 * --- |
|
24 * |
|
25 * The license mentioned above concerns the source code only. Using the |
|
26 * EtherCAT technology and brand is only permitted in compliance with the |
|
27 * industrial property and similar rights of Beckhoff Automation GmbH. |
|
28 * |
|
29 *****************************************************************************/ |
|
30 |
|
31 /** \file |
|
32 * |
|
33 * EtherCAT virtual TTY interface. |
|
34 * |
|
35 * \defgroup TTYInterface EtherCAT Virtual TTY Interface |
|
36 * |
|
37 * @{ |
|
38 */ |
|
39 |
|
40 /*****************************************************************************/ |
|
41 |
|
42 #ifndef __ECTTY_H__ |
|
43 #define __ECTTY_H__ |
|
44 |
|
45 /****************************************************************************** |
|
46 * Data types |
|
47 *****************************************************************************/ |
|
48 |
|
49 struct ec_tty; |
|
50 typedef struct ec_tty ec_tty_t; /**< \see ec_tty */ |
|
51 |
|
52 /****************************************************************************** |
|
53 * Global functions |
|
54 *****************************************************************************/ |
|
55 |
|
56 /** Create a virtual TTY interface. |
|
57 * |
|
58 * \return Pointer to the interface object, otherwise an ERR_PTR value. |
|
59 */ |
|
60 ec_tty_t *ectty_create(void); |
|
61 |
|
62 /****************************************************************************** |
|
63 * TTY interface methods |
|
64 *****************************************************************************/ |
|
65 |
|
66 /** Releases a virtual TTY interface. |
|
67 */ |
|
68 void ectty_free( |
|
69 ec_tty_t *tty /**< TTY interface. */ |
|
70 ); |
|
71 |
|
72 /*****************************************************************************/ |
|
73 |
|
74 /** @} */ |
|
75 |
|
76 #endif |