xref: /illumos-gate/usr/src/man/man3c/cfsetispeed.3c (revision 8a2b682e57a046b828f37bcde1776f131ef4629f)
1.\"
2.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3.\" permission to reproduce portions of its copyrighted documentation.
4.\" Original documentation from The Open Group can be obtained online at
5.\" http://www.opengroup.org/bookstore/.
6.\"
7.\" The Institute of Electrical and Electronics Engineers and The Open
8.\" Group, have given us permission to reprint portions of their
9.\" documentation.
10.\"
11.\" In the following statement, the phrase ``this text'' refers to portions
12.\" of the system documentation.
13.\"
14.\" Portions of this text are reprinted and reproduced in electronic form
15.\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16.\" Standard for Information Technology -- Portable Operating System
17.\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18.\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19.\" Engineers, Inc and The Open Group.  In the event of any discrepancy
20.\" between these versions and the original IEEE and The Open Group
21.\" Standard, the original IEEE and The Open Group Standard is the referee
22.\" document.  The original Standard can be obtained online at
23.\" http://www.opengroup.org/unix/online.html.
24.\"
25.\" This notice shall appear on any product containing this material.
26.\"
27.\" The contents of this file are subject to the terms of the
28.\" Common Development and Distribution License (the "License").
29.\" You may not use this file except in compliance with the License.
30.\"
31.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32.\" or http://www.opensolaris.org/os/licensing.
33.\" See the License for the specific language governing permissions
34.\" and limitations under the License.
35.\"
36.\" When distributing Covered Code, include this CDDL HEADER in each
37.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38.\" If applicable, add the following below this CDDL HEADER, with the
39.\" fields enclosed by brackets "[]" replaced with your own identifying
40.\" information: Portions Copyright [yyyy] [name of copyright owner]
41.\"
42.\"
43.\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
44.\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
45.\" Copyright 2019, Joyent, Inc.
46.\"
47.Dd January 20, 2019
48.Dt CFSETISPEED 3C
49.Os
50.Sh NAME
51.Nm cfsetispeed ,
52.Nm cfsetospeed
53.Nd set input and output baud rate
54.Sh SYNOPSIS
55.In termios.h
56.Ft int
57.Fo cfsetispeed
58.Fa "struct termios *termios_p"
59.Fa "speed_t speed"
60.Fc
61.Ft int
62.Fo cfsetospeed
63.Fa "struct termios *termios_p"
64.Fa "speed_t speed"
65.Fc
66.Sh DESCRIPTION
67The
68.Fn cfsetispeed
69function sets the input baud rate stored in the
70structure pointed to by
71.Fa termios_p
72to
73.Fa speed .
74.Pp
75The
76.Fn cfsetospeed
77function sets the output baud rate stored in the
78structure pointed to by
79.Fa termios_p
80to
81.Fa speed .
82.Pp
83There is no effect on the baud rates set in the hardware until a subsequent
84successful call to
85.Xr tcsetattr 3C
86on the same
87.Vt termios
88structure.
89.Sh RETURN VALUES
90Upon successful completion,
91.Fn cfsetispeed
92and
93.Fn cfsetospeed
94return
95.Sy 0 .
96Otherwise
97.Sy \(mi1
98is returned, and
99.Va errno
100may be set to indicate the error.
101.Sh ERRORS
102The
103.Fn cfsetispeed
104and
105.Fn cfsetospeed
106functions may fail if:
107.Bl -tag -width EINVAL
108.It Er EINVAL
109The
110.Fa speed
111value is not a valid baud rate.
112.It Er EINVAL
113The value of
114.Fa speed
115is outside the range of possible speed values as specified in
116.In termios.h .
117.El
118.Sh INTERFACE STABILITY
119Standard
120.Sh MT-LEVEL
121MT-Safe
122.Pp
123Async-Signal-Safe
124.Sh SEE ALSO
125.Xr cfgetispeed 3C ,
126.Xr tcsetattr 3C ,
127.Xr attributes 5 ,
128.Xr standards 5 ,
129.Xr termio 7I
130