summaryrefslogtreecommitdiffstats log msg author committer range
blob: 0f1672ee10f000cc612023587de46da40b9e0a6d (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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 ``` ``````.. SPDX-License-Identifier: CC-BY-SA-4.0 .. Copyright (C) 1988, 2002 On-Line Applications Research Corporation (OAR) Device- and Class- Specific Functions Manager ############################################# Introduction ============ The device- and class- specific functions manager is ... The directives provided by the device- and class- specific functions manager are: - cfgetispeed_ - Reads terminal input baud rate - cfgetospeed_ - Reads terminal output baud rate - cfsetispeed_ - Sets terminal input baud rate - cfsetospeed_ - Set terminal output baud rate - tcgetattr_ - Gets terminal attributes - tcsetattr_ - Set terminal attributes - tcsendbreak_ - Sends a break to a terminal - tcdrain_ - Waits for all output to be transmitted to the terminal - tcflush_ - Discards terminal data - tcflow_ - Suspends/restarts terminal output - tcgetpgrp_ - Gets foreground process group ID - tcsetpgrp_ - Sets foreground process group ID Background ========== There is currently no text in this section. Operations ========== There is currently no text in this section. Directives ========== This section details the device- and class- specific functions manager's directives. A subsection is dedicated to each of this manager's directives and describes the calling sequence, related constants, usage, and status codes. .. _cfgetispeed: cfgetispeed - Reads terminal input baud rate -------------------------------------------- .. index:: cfgetispeed .. index:: reads terminal input baud rate **CALLING SEQUENCE:** .. code-block:: c #include speed_t cfgetispeed( const struct termios *termios_p ); **STATUS CODES:** The ``cfgetispeed()`` function returns a code for baud rate. **DESCRIPTION:** The ``cfsetispeed()`` function stores a code for the terminal speed stored in a struct termios. The codes are defined in ```` by the macros ``BO``, ``B50``, ``B75``, ``B110``, ``B134``, ``B150``, ``B200``, ``B300``, ``B600``, ``B1200``, ``B1800``, ``B2400``, ``B4800``, ``B9600``, ``B19200``, and ``B38400``. The ``cfsetispeed()`` function does not do anything to the hardware. It merely stores a value for use by ``tcsetattr()``. **NOTES:** Baud rates are defined by symbols, such as ``B110``, ``B1200``, ``B2400``. The actual number returned for any given speed may change from system to system. .. _cfgetospeed: cfgetospeed - Reads terminal output baud rate --------------------------------------------- .. index:: cfgetospeed .. index:: reads terminal output baud rate **CALLING SEQUENCE:** .. code-block:: c #include speed_t cfgetospeed( const struct termios *termios_p ); **STATUS CODES:** The ``cfgetospeed()`` function returns the termios code for the baud rate. **DESCRIPTION:** The ``cfgetospeed()`` function returns a code for the terminal speed stored in a ``struct termios``. The codes are defined in ```` by the macros ``BO``, ``B50``, ``B75``, ``B110``, ``B134``, ``B150``, ``B200``, ``B300``, ``B600``, ``B1200``, ``B1800``, ``B2400``, ``B4800``, ``B9600``, ``B19200``, and ``B38400``. The ``cfgetospeed()`` function does not do anything to the hardware. It merely returns the value stored by a previous call to ``tcgetattr()``. **NOTES:** Baud rates are defined by symbols, such as ``B110``, ``B1200``, ``B2400``. The actual number returned for any given speed may change from system to system. .. _cfsetispeed: cfsetispeed - Sets terminal input baud rate ------------------------------------------- .. index:: cfsetispeed .. index:: sets terminal input baud rate **CALLING SEQUENCE:** .. code-block:: c #include int cfsetispeed( struct termios *termios_p, speed_t speed ); **STATUS CODES:** The ``cfsetispeed()`` function returns a zero when successful and returns -1 when an error occurs. **DESCRIPTION:** The ``cfsetispeed()`` function stores a code for the terminal speed stored in a struct termios. The codes are defined in ```` by the macros ``BO``, ``B50``, ``B75``, ``B110``, ``B134``, ``B150``, ``B200``, ``B300``, ``B600``, ``B1200``, ``B1800``, ``B2400``, ``B4800``, ``B9600``, ``B19200``, and ``B38400``. **NOTES:** This function merely stores a value in the ``termios`` structure. It does not change the terminal speed until a ``tcsetattr()`` is done. It does not detect impossible terminal speeds. .. _cfsetospeed: cfsetospeed - Sets terminal output baud rate -------------------------------------------- .. index:: cfsetospeed .. index:: sets terminal output baud rate **CALLING SEQUENCE:** .. code-block:: c #include int cfsetospeed( struct termios *termios_p, speed_t speed ); **STATUS CODES:** The ``cfsetospeed()`` function returns a zero when successful and returns -1 when an error occurs. **DESCRIPTION:** The ``cfsetospeed()`` function stores a code for the terminal speed stored in a struct ``termios``. The codes are defiined in ```` by the macros ``BO``, ``B50``, ``B75``, ``B110``, ``B134``, ``B150``, ``B200``, ``B300``, ``B600``, ``B1200``, ``B1800``, ``B2400``, ``B4800``, ``B9600``, ``B19200``, and ``B38400``. The ``cfsetospeed()`` function does not do anything to the hardware. It merely stores a value for use by ``tcsetattr()``. **NOTES:** This function merely stores a value in the ``termios`` structure. It does not change the terminal speed until a ``tcsetattr()`` is done. It does not detect impossible terminal speeds. .. _tcgetattr: tcgetattr - Gets terminal attributes ------------------------------------ .. index:: tcgetattr .. index:: gets terminal attributes **CALLING SEQUENCE:** .. code-block:: c #include int tcgetattr( int fildes, struct termios *termios_p ); **STATUS CODES:** .. list-table:: :class: rtems-table * - ``EBADF`` - Invalid file descriptor * - ``ENOOTY`` - Terminal control function attempted for a file that is not a terminal. **DESCRIPTION:** The ``tcgetattr()`` gets the parameters associated with the terminal referred to by ``fildes`` and stores them into the ``termios()`` structure pointed to by ``termios_p``. **NOTES:** NONE .. _tcsetattr: tcsetattr - Set terminal attributes ----------------------------------- .. index:: tcsetattr .. index:: set terminal attributes **CALLING SEQUENCE:** .. code-block:: c #include int tcsetattr( int fildes, int optional_actions, const struct termios *termios_p ); **STATUS CODES:** .. list-table:: :class: rtems-table * - ``E`` - The **DESCRIPTION:** **NOTES:** .. _tcsendbreak: tcsendbreak - Sends a break to a terminal ----------------------------------------- .. index:: tcsendbreak .. index:: sends a break to a terminal **CALLING SEQUENCE:** .. code-block:: c #include int tcsendbreak( int fildes, int duration ); **STATUS CODES:** .. list-table:: :class: rtems-table * - ``E`` - The **DESCRIPTION:** **NOTES:** This routine is not currently supported by RTEMS but could be in a future version. .. _tcdrain: tcdrain - Waits for all output to be transmitted to the terminal. ----------------------------------------------------------------- .. index:: tcdrain .. index:: waits for all output to be transmitted to the terminal. **CALLING SEQUENCE:** .. code-block:: c #include int tcdrain( int fildes ); **STATUS CODES:** .. list-table:: :class: rtems-table * - ``EBADF`` - Invalid file descriptor * - ``EINTR`` - Function was interrupted by a signal * - ``ENOTTY`` - Terminal control function attempted for a file that is not a terminal. **DESCRIPTION:** The ``tcdrain()`` function waits until all output written to ``fildes`` has been transmitted. **NOTES:** NONE .. _tcflush: tcflush - Discards terminal data -------------------------------- .. index:: tcflush .. index:: discards terminal data **CALLING SEQUENCE:** .. code-block:: c #include int tcflush( int fildes, int queue_selector ); **STATUS CODES:** .. list-table:: :class: rtems-table * - ``E`` - The **DESCRIPTION:** **NOTES:** This routine is not currently supported by RTEMS but could be in a future version. .. _tcflow: tcflow - Suspends/restarts terminal output. ------------------------------------------- .. index:: tcflow .. index:: suspends/restarts terminal output. **CALLING SEQUENCE:** .. code-block:: c #include int tcflow( int fildes, int action ); **STATUS CODES:** .. list-table:: :class: rtems-table * - ``E`` - The **DESCRIPTION:** **NOTES:** This routine is not currently supported by RTEMS but could be in a future version. .. _tcgetpgrp: tcgetpgrp - Gets foreground process group ID -------------------------------------------- .. index:: tcgetpgrp .. index:: gets foreground process group id **CALLING SEQUENCE:** .. code-block:: c #include pid_t tcgetpgrp( int fildes ); **STATUS CODES:** .. list-table:: :class: rtems-table * - ``E`` - The **DESCRIPTION:** **NOTES:** This routine is not currently supported by RTEMS but could be in a future version. .. _tcsetpgrp: tcsetpgrp - Sets foreground process group ID -------------------------------------------- .. index:: tcsetpgrp .. index:: sets foreground process group id **CALLING SEQUENCE:** .. code-block:: c #include int tcsetpgrp( int fildes, pid_t pgid_id ); **STATUS CODES:** .. list-table:: :class: rtems-table * - ``E`` - The **DESCRIPTION:** **NOTES:** This routine is not currently supported by RTEMS but could be in a future version. ``````