xref: /illumos-gate/usr/src/man/man3c/cfgetispeed.3c (revision bbf21555)
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 CFGETISPEED 3C
49.Os
50.Sh NAME
51.Nm cfgetispeed ,
52.Nm cfgetospeed
53.Nd get input and output baud rate
54.Sh SYNOPSIS
55.In termios.h
56.Ft speed_t
57.Fo cfgetispeed
58.Fa "const struct termios *termios_p"
59.Fc
60.Ft speed_t
61.Fo cfgetospeed
62.Fa "const struct termios *termios_p"
63.Fc
64.Sh DESCRIPTION
65The
66.Fn cfgetispeed
67function extracts the input baud rate from the
68.Vt termios
69structure to which the
70.Fa termios_p
71argument points.
72.Pp
73The
74.Fn cfgetospeed
75function extracts the output baud rate from the
76.Vt termios
77structure to which the
78.Fa termios_p
79argument points.
80.Pp
81These functions return exactly the value in the
82.Vt termios
83data structure, without interpretation.
84.Sh RETURN VALUES
85Upon successful completion,
86.Fn cfgetispeed
87returns a value of type
88.Vt speed_t
89representing the input baud rate.
90.Pp
91Upon successful completion,
92.Fn cfgetospeed
93returns a value of type
94.Vt speed_t
95representing the output baud rate.
96.Sh ERRORS
97No errors are defined.
98.Sh INTERFACE STABILITY
99Standard
100.Sh MT-LEVEL
101MT-Safe
102.Pp
103Async-Signal-Safe
104.Sh SEE ALSO
105.Xr cfsetispeed 3C ,
106.Xr tcgetattr 3C ,
107.Xr termio 4I ,
108.Xr attributes 7 ,
109.Xr standards 7
110