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

#include <linux/termios.h>

    46

    47

/******************************************************************************

    48

 * Data types

    49

 *****************************************************************************/

    50

    51

struct ec_tty;

    52

typedef struct ec_tty ec_tty_t; /**< \see ec_tty */

    53

    54

/** Operations on the virtual TTY interface.

    55

 */

    56

typedef struct {

    57

    int (*cflag_changed)(void *, tcflag_t); /**< Called when the serial

    58

                                              * settings shall be changed. The

    59

                                              * \a cflag argument contains the

    60

                                              * new settings. */

    61

} ec_tty_operations_t;

    62

    63

/******************************************************************************

    64

 * Global functions

    65

 *****************************************************************************/

    66

    67

/** Create a virtual TTY interface.

    68

 *

    69

 * \param ops Set of callbacks.

    70

 * \param cb_data Arbitrary data, that is passed to any callback.

    71

 *

    72

 * \return Pointer to the interface object, otherwise an ERR_PTR value.

    73

 */

    74

ec_tty_t *ectty_create(

    75

        const ec_tty_operations_t *ops,

    76

        void *cb_data

    77

        );

    78

    79

/******************************************************************************

    80

 * TTY interface methods

    81

 *****************************************************************************/

    82

    83

/** Releases a virtual TTY interface.

    84

 */

    85

void ectty_free(

    86

        ec_tty_t *tty /**< TTY interface. */

    87

        );

    88

    89

/** Reads data to send from the TTY interface.

    90

 *

    91

 * If there are data to send, they are copied into the \a buffer. At maximum,

    92

 * \a size bytes are copied. The actual number of bytes copied is returned.

    93

 *

    94

 * \return Number of bytes copied.

    95

 */

    96

unsigned int ectty_tx_data(

    97

        ec_tty_t *tty, /**< TTY interface. */

    98

        uint8_t *buffer, /**< Buffer for data to transmit. */

    99

        size_t size /**< Available space in \a buffer. */

   100

        );

   101

   102

/** Pushes received data to the TTY interface.

   103

 */

   104

void ectty_rx_data(

   105

        ec_tty_t *tty, /**< TTY interface. */

   106

        const uint8_t *buffer, /**< Buffer with received data. */

   107

        size_t size /**< Number of bytes in \a buffer. */

   108

        );

   109

   110

/*****************************************************************************/

   111

   112

/** @} */

   113

   114

#endif