summaryrefslogtreecommitdiff
path: root/nuttx/lib/termios/lib_setspeed.c
blob: 13a0cc57a6eaebd8d48033204b0c6187ce983b69 (plain) (blame)
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
110
/****************************************************************************
 * lib/termios/lib_setspeed.c
 *
 *   Copyright (C) 2012 Gregory Nutt. All rights reserved.
 *   Author: Gregory Nutt <gnutt@nuttx.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name NuttX nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#include <sys/str_tty.h>
#include <sys/ioctl.h>

#include <nuttx/serial/tioctl.h>

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

/****************************************************************************
 * Private Variables
 ****************************************************************************/

/****************************************************************************
 * Public Variables
 ****************************************************************************/

/****************************************************************************
 * Private Functions
 ****************************************************************************/

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Name: set_speed
 *
 * Descripton:
 *   set_speed(), get_speed(), and reset_speed are non-standard AIX-like
 *   interfaces to simplify TTY baud rate operations.
 *
 *   The baud rate functions set_speed() and get_speed() are provided to
 *   allow the applications to program any value of the baud rate that is
 *   supported by the serial driver, but that cannot be expressed using
 *   the termios subroutines cfsetospeed, cfsetispeed, cfgetospeed,
 *   and cfsgetispeed. Those subroutines are limited to the set of values
 *   defined termios.h.
 *
 *   Normal mode: This is the default mode, in which a termios supported
 *   speed is in use.
 *
 *   Speed-extended mode: This mode is entered by calling set_speed() with
 *   a non-termios supported speed at the configuration of the line. In this
 *   mode, all the calls to tcgetattr subroutine or TCGETS ioctl subroutine
 *   will have B50 in the returned termios structure.
 *
 *   If tcsetattr() or TCSETS, TCSETAF, or TCSETAW ioctl calls the driver
 *   and attempts to set B50, the actual baud rate is not changed. If it
 *   attempts to set any other termios-supported speed, will switch back
 *   to the normal mode and the requested baud rate is set.  Calling
 *   reset_speed subroutine is another way to switch back to the
 *  normal mode.
 *
 * Input Parameters:
 *   fd  - The 'fd' argument is an open file descriptor associated with a
 *         terminal.
 *   speed - The new, extended baud
 *
 * Returned Value:
 *   Upon successful completion, 0 is returned. Otherwise, -1 is returned and
 *   errno is set to indicate the error.
 *
 ****************************************************************************/

int set_speed(int fd, int32_t speed)
{
  return ioctl(fd, TIOCSETSPEED, (unsigned long)speed);
}