os/ossrv/genericopenlibs/openenvcore/include/sys/ttycom.dosc
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/include/sys/ttycom.dosc	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,542 @@
     1.4 +/** @file  ../include/sys/ttycom.h
     1.5 +@internalComponent
     1.6 +*/
     1.7 +
     1.8 +/** @struct winsize
     1.9 +
    1.10 +Window or terminal size structure.  This information is stored by the kernel in order to provide a consistent interface, but is not used by the kernel.
    1.11 +
    1.12 +@publishedAll
    1.13 +@externallyDefinedApi
    1.14 +*/
    1.15 +
    1.16 +/** @var winsize::ws_row
    1.17 +rows, in characters
    1.18 +*/
    1.19 +
    1.20 +/** @var winsize::ws_col
    1.21 +columns, in characters  
    1.22 +*/
    1.23 +
    1.24 +/** @var winsize::ws_xpixel
    1.25 +horizontal size, pixels
    1.26 +*/
    1.27 +
    1.28 +/** @var winsize::ws_ypixel
    1.29 +vertical size, pixels
    1.30 +*/
    1.31 +
    1.32 +/** @def TIOCGETD	
    1.33 +
    1.34 +get line discipline
    1.35 +
    1.36 +@publishedAll
    1.37 +@externallyDefinedApi
    1.38 +*/
    1.39 +
    1.40 +/** @def TIOCSETD	
    1.41 +
    1.42 +set line discipline 
    1.43 +
    1.44 +@publishedAll
    1.45 +@externallyDefinedApi
    1.46 +*/
    1.47 +
    1.48 +
    1.49 +/** @def TIOCCBRK	
    1.50 +
    1.51 +clear break bit
    1.52 + 
    1.53 +@publishedAll
    1.54 +@externallyDefinedApi
    1.55 +*/
    1.56 +
    1.57 +
    1.58 +/** @def TIOCSBRK	
    1.59 +
    1.60 +set break bit
    1.61 + 
    1.62 +@publishedAll
    1.63 +@externallyDefinedApi
    1.64 +*/
    1.65 +
    1.66 +
    1.67 +/** @def TIOCSDTR	 
    1.68 +
    1.69 +set data terminal ready 
    1.70 +
    1.71 +@publishedAll
    1.72 +@externallyDefinedApi
    1.73 +*/
    1.74 +
    1.75 +
    1.76 +/** @def TIOCCDTR
    1.77 +
    1.78 +clear data terminal ready 
    1.79 +	 
    1.80 +@publishedAll
    1.81 +@externallyDefinedApi
    1.82 +*/
    1.83 +
    1.84 +
    1.85 +/** @def TIOCGPGRP	
    1.86 +
    1.87 +get pgrp of tty
    1.88 +
    1.89 +@publishedAll
    1.90 +@externallyDefinedApi
    1.91 +*/
    1.92 +
    1.93 +/** @def TIOCSPGRP
    1.94 +
    1.95 +set pgrp of tty 
    1.96 +	
    1.97 +@publishedAll
    1.98 +@externallyDefinedApi
    1.99 +*/
   1.100 +
   1.101 +
   1.102 +/** @def TIOCGETA	
   1.103 +
   1.104 +get termios struct
   1.105 +
   1.106 +@publishedAll
   1.107 +@externallyDefinedApi
   1.108 +*/
   1.109 +
   1.110 +
   1.111 +/** @def TIOCSETA	
   1.112 +
   1.113 +set termios struct 
   1.114 +
   1.115 +@publishedAll
   1.116 +@externallyDefinedApi
   1.117 +*/
   1.118 +
   1.119 +
   1.120 +/** @def TIOCSETAW	
   1.121 +
   1.122 +drain output, set
   1.123 +
   1.124 +@publishedAll
   1.125 +@externallyDefinedApi
   1.126 +*/
   1.127 +
   1.128 +
   1.129 +/** @def TIOCSETAF	
   1.130 +
   1.131 +drn out, fls in, set 
   1.132 +
   1.133 +@publishedAll
   1.134 +@externallyDefinedApi
   1.135 +*/
   1.136 +
   1.137 +
   1.138 +/** @def TIOCOUTQ	
   1.139 +
   1.140 +output queue size
   1.141 +
   1.142 +@publishedAll
   1.143 +@externallyDefinedApi
   1.144 +*/
   1.145 +
   1.146 +
   1.147 +/** @def TIOCSTI		
   1.148 +
   1.149 +simulate terminal input
   1.150 +
   1.151 +@publishedAll
   1.152 +@externallyDefinedApi
   1.153 +*/
   1.154 +
   1.155 +
   1.156 +/** @def TIOCNOTTY	
   1.157 +
   1.158 +void tty association
   1.159 + 
   1.160 +@publishedAll
   1.161 +@externallyDefinedApi
   1.162 +*/
   1.163 +
   1.164 +
   1.165 +/** @def TIOCSTOP	
   1.166 +
   1.167 +stop output.
   1.168 + 
   1.169 +@publishedAll
   1.170 +@externallyDefinedApi
   1.171 +*/
   1.172 +
   1.173 +/** @def TIOCSTART	
   1.174 +
   1.175 +Start output. 
   1.176 +
   1.177 +@publishedAll
   1.178 +@externallyDefinedApi
   1.179 +*/
   1.180 +
   1.181 +
   1.182 +/** @def TIOCSCTTY	
   1.183 +
   1.184 +become controlling tty
   1.185 + 
   1.186 +@publishedAll
   1.187 +@externallyDefinedApi
   1.188 +*/
   1.189 +
   1.190 +/** @def TIOCDRAIN	 
   1.191 +
   1.192 +wait till output drained
   1.193 +
   1.194 +@publishedAll
   1.195 +@externallyDefinedApi
   1.196 +*/
   1.197 +
   1.198 +
   1.199 +/** @def TIOCEXCL	
   1.200 +
   1.201 + set exclusive use of tty 
   1.202 + 
   1.203 +@publishedAll
   1.204 +@externallyDefinedApi
   1.205 +*/
   1.206 +
   1.207 +/** @def TIOCNXCL	 
   1.208 +
   1.209 +reset exclusive use of tty
   1.210 +
   1.211 +@publishedAll
   1.212 +@externallyDefinedApi
   1.213 +*/
   1.214 +
   1.215 +
   1.216 +/** @def TIOCFLUSH	
   1.217 +
   1.218 +flush buffers
   1.219 +
   1.220 +@publishedAll
   1.221 +@externallyDefinedApi
   1.222 +*/
   1.223 +
   1.224 +/** @def TIOCGWINSZ	
   1.225 +
   1.226 +get window size
   1.227 +
   1.228 +@publishedAll
   1.229 +@externallyDefinedApi
   1.230 +*/
   1.231 +
   1.232 +/** @def TIOCSWINSZ	
   1.233 +
   1.234 +set window size
   1.235 +
   1.236 +@publishedAll
   1.237 +@externallyDefinedApi
   1.238 +*/
   1.239 +
   1.240 +
   1.241 +/** @def TIOCCONS	
   1.242 +
   1.243 +become virtual console
   1.244 +
   1.245 +@publishedAll
   1.246 +@externallyDefinedApi
   1.247 +*/
   1.248 +
   1.249 +
   1.250 +/** @def TIOCMSET	
   1.251 +
   1.252 +set all modem bits
   1.253 +
   1.254 +@publishedAll
   1.255 +@externallyDefinedApi
   1.256 +*/
   1.257 +
   1.258 +/** @def TIOCMBIS	
   1.259 +
   1.260 +bis modem bits
   1.261 +
   1.262 +@publishedAll
   1.263 +@externallyDefinedApi
   1.264 +*/
   1.265 +
   1.266 +/** @def TIOCMBIC	
   1.267 +
   1.268 +bic modem bits
   1.269 +
   1.270 +@publishedAll
   1.271 +@externallyDefinedApi
   1.272 +*/
   1.273 +
   1.274 +
   1.275 +/** @def TIOCMGET	
   1.276 +
   1.277 +get all modem bits
   1.278 +
   1.279 +@publishedAll
   1.280 +@externallyDefinedApi
   1.281 +*/
   1.282 +
   1.283 +
   1.284 +/** @def TIOCM_LE	
   1.285 +
   1.286 +line enable
   1.287 +
   1.288 +@publishedAll
   1.289 +@externallyDefinedApi
   1.290 +*/
   1.291 +
   1.292 +
   1.293 +/** @def TIOCM_DTR	
   1.294 +
   1.295 +data terminal ready
   1.296 +
   1.297 +@publishedAll
   1.298 +@externallyDefinedApi
   1.299 +*/
   1.300 +
   1.301 +
   1.302 +/** @def TIOCM_RTS	
   1.303 +
   1.304 +request to send
   1.305 +
   1.306 +@publishedAll
   1.307 +@externallyDefinedApi
   1.308 +*/
   1.309 +
   1.310 +
   1.311 +/** @def TIOCM_ST	
   1.312 +
   1.313 +secondary transmit
   1.314 +
   1.315 +@publishedAll
   1.316 +@externallyDefinedApi
   1.317 +*/
   1.318 +
   1.319 +
   1.320 +/** @def TIOCM_SR
   1.321 +
   1.322 +secondary receive
   1.323 +	
   1.324 +@publishedAll
   1.325 +@externallyDefinedApi
   1.326 +*/
   1.327 +
   1.328 +
   1.329 +/** @def TIOCM_CTS
   1.330 +
   1.331 +clear to send
   1.332 +	
   1.333 +@publishedAll
   1.334 +@externallyDefinedApi
   1.335 +*/
   1.336 +
   1.337 +
   1.338 +/** @def TIOCM_DCD	
   1.339 +
   1.340 +data carrier detect
   1.341 +	
   1.342 +@publishedAll
   1.343 +@externallyDefinedApi
   1.344 +*/
   1.345 +
   1.346 +/** @def TIOCM_RI 		
   1.347 +
   1.348 +ring indicate
   1.349 +
   1.350 +@publishedAll
   1.351 +@externallyDefinedApi
   1.352 +*/
   1.353 +
   1.354 +
   1.355 +/** @def TIOCM_DSR	
   1.356 +
   1.357 +data set ready
   1.358 +
   1.359 +@publishedAll
   1.360 +@externallyDefinedApi
   1.361 +*/
   1.362 +
   1.363 +/** @def TIOCM_CD	
   1.364 +
   1.365 +data carrier detect
   1.366 +	
   1.367 +@publishedAll
   1.368 +@externallyDefinedApi
   1.369 +*/
   1.370 +
   1.371 +
   1.372 +/** @def TIOCM_CAR	
   1.373 +
   1.374 +data carrier detect
   1.375 +
   1.376 +@publishedAll
   1.377 +@externallyDefinedApi
   1.378 +*/
   1.379 +
   1.380 +/** @def TIOCM_RNG	
   1.381 +
   1.382 +ring indicate
   1.383 +
   1.384 +@publishedAll
   1.385 +@externallyDefinedApi
   1.386 +*/
   1.387 +
   1.388 +/** @def TIOCPKT_DATA	
   1.389 +
   1.390 +data packet
   1.391 +	
   1.392 +@publishedAll
   1.393 +@released
   1.394 +*/
   1.395 +
   1.396 +/** @def TIOCPKT_FLUSHREAD	
   1.397 +
   1.398 +flush packet
   1.399 +
   1.400 +@publishedAll
   1.401 +@released
   1.402 +*/
   1.403 +
   1.404 +
   1.405 +/** @def TIOCPKT_FLUSHWRITE	
   1.406 +
   1.407 +flush packet 
   1.408 +
   1.409 +@publishedAll
   1.410 +@released
   1.411 +*/
   1.412 +
   1.413 +/** @def TIOCPKT_STOP		
   1.414 +
   1.415 +stop output
   1.416 +
   1.417 +@publishedAll
   1.418 +@released
   1.419 +*/
   1.420 +
   1.421 +
   1.422 +/** @def TIOCPKT_START		
   1.423 +
   1.424 +start output
   1.425 +
   1.426 +@publishedAll
   1.427 +@released
   1.428 +*/
   1.429 +
   1.430 +
   1.431 +/** @def TIOCPKT_NOSTOP	
   1.432 +
   1.433 +no more stop output, start output
   1.434 +	
   1.435 +@publishedAll
   1.436 +@released
   1.437 +*/
   1.438 +
   1.439 +/** @def TIOCPKT_DOSTOP		
   1.440 +
   1.441 +now do stop output, start output
   1.442 +
   1.443 +@publishedAll
   1.444 +@released
   1.445 +*/
   1.446 +
   1.447 +/** @def TIOCPKT_IOCTL		
   1.448 +
   1.449 +state change of pty driver
   1.450 +
   1.451 +@publishedAll
   1.452 +@released
   1.453 +*/
   1.454 +
   1.455 +
   1.456 +/** @def TIOCEXT	
   1.457 +
   1.458 +pty: external processing
   1.459 +	
   1.460 +@publishedAll
   1.461 +@released
   1.462 +*/
   1.463 +
   1.464 +
   1.465 +/** @def TIOCSIG	
   1.466 +
   1.467 +pty: generate signal
   1.468 +	 
   1.469 +@publishedAll
   1.470 +@released
   1.471 +*/
   1.472 +
   1.473 +
   1.474 +/** @def TIOCMSDTRWAIT
   1.475 +
   1.476 +modem: set wait on close
   1.477 +	
   1.478 +@publishedAll
   1.479 +@released
   1.480 +*/
   1.481 +
   1.482 +
   1.483 +/** @def TIOCTIMESTAMP	
   1.484 +
   1.485 +enable or get timestamp of last input event
   1.486 +
   1.487 +@publishedAll
   1.488 +@released
   1.489 +*/
   1.490 +
   1.491 +
   1.492 +/** @def TIOCSDRAINWAIT	
   1.493 +
   1.494 +set ttywait timeout
   1.495 +
   1.496 +@publishedAll
   1.497 +@released
   1.498 +*/
   1.499 +
   1.500 +
   1.501 +
   1.502 +/** @def TTYDISC	
   1.503 +
   1.504 +termios tty line discipline 
   1.505 +	
   1.506 +@publishedAll
   1.507 +@released
   1.508 +*/
   1.509 +
   1.510 +
   1.511 +/** @def PPPDISC	
   1.512 +
   1.513 +PPP discipline 
   1.514 +	
   1.515 +@publishedAll
   1.516 +@released
   1.517 +*/
   1.518 +
   1.519 +
   1.520 +/** @def NETGRAPHDISC	
   1.521 +
   1.522 +Netgraph tty node discipline 
   1.523 +
   1.524 +@publishedAll
   1.525 +@released
   1.526 +*/
   1.527 +
   1.528 +
   1.529 +/** @def H4DISC	
   1.530 +
   1.531 +Netgraph Bluetooth H4 discipline
   1.532 +	
   1.533 +@publishedAll
   1.534 +@externallyDefinedApi
   1.535 +*/						
   1.536 +
   1.537 +
   1.538 +						
   1.539 +
   1.540 +						 
   1.541 +						
   1.542 +
   1.543 +
   1.544 +
   1.545 +