IOCTL_CONSOLE(2) Manual do Programador do Linux IOCTL_CONSOLE(2)

ioctl_console - ioctls para terminais de console e consoles virtuais

As seguintes requisições ioctl(2) específicas do Linux são suportadas para terminais de console e consoles virtuais. Cada uma requer um terceiro argumento, presumido aqui como sendo argp.

Obtém os estados dos LEDs. argp aponta para um char. Os três menores bits de *argp são definidos com o estado dos LEDs, como segue:
LED_CAP 0x04 led do caps lock
LED_NUM 0x02 led do num lock
LED_SCR 0x01 led do scroll lock
Define os LEDs. Os LEDs são definidos para corresponderem aos três menores bits do inteiro long unsigned de argp. De outra forma, se um bit de ordem maior é definido, os LEDs são revertidos para o estado normal: mostrando o estado das funções do teclado de caps lock, num lock e scroll lock.

Antes do Linux 1.1.54, os LEDs apenas refletiam o estado do correspondente do sinalizador do teclado, e KDGETLED/KDSETLED além disso alteraria o sinalizador do teclado. Desde o Linux 1.1.54 os LEDs podem ser usados para exibir informações arbitrárias, mas por padrão elas mostram o sinalizador de teclado. As duas seguintes ioctls são usadas para acessar o sinalizador de teclado.

Obtém o sinalizador de teclado CapsLock, NumLock, ScrollLock (sem luzes). argp aponta para um caractere no qual é definido com o estado do sinalizador. Os três bits de menor ordem (máscara 0x7) recebem o estado atual do sinalizador, e os bits de menor ordem nos próximos quatro bits (máscara 0x70) obtém o estado padrão do sinalizador. (Desde o Linux 1.1.54.)
Define os sinalizadores de teclado CapsLock, NumLock, ScrollLock (sem luzes). argp é um inteiro longo sem sinal que tem o estado do sinalizador desejado. Os três bits de menor ordem (máscara 0x7) tem o estado do sinalizador, e os bits de menor ordem nos próximos 4 bits (máscara 0x70) tem o estado padrão do sinalizador. (Desde o Linux 1.1.54.)
Obtém o tipo de teclado. Este retorna o valor KB_101, definido como 0x02.
Adiciona uma porta de E/S como válida. Equivalente a ioperm(arg,1,1).
Remove uma porta de E/S como válida. Equivalente a ioperm(arg,1,0).
Habilita a E/S para a placa de vídeo. Equivalente a ioperm(0x3b4, 0x3df-0x3b4+1, 1).
Desabilita a E/S para a placa de vídeo. Equivalente a ioperm(0x3b4, 0x3df-0x3b4+1, 0).
Define o modo texto/gráfico. argp é um inteiro sem sinal contendo um destes:
KD_TEXT 0x00
KD_GRAPHICS 0x01
Obtém o modo texto/gráfico. argp aponta para um int o qual é definido para um dos valores acima para KDSETMODE.
Gera um som de comprimento especificado. Os 16 bits de inteiro longo sem sinal em argp especificam o período em ciclos de relógio, e os 16 bits mais altos entregam a duração em milissegundos. Se a duração é zero, o som é desligado. O controle retorna imediatamente. Por exemplo, argp = (125<<16) + 0x637 especificaria o bipe normalmente associado com Ctrl-G. (Portanto, desde o Linux 0.99pl1; interrompido no Linux 2.1.49-50.)
Inicia ou termina a geração do som. O 16 bits mais baixos de argp especificam o período em ciclos de relógio (que é, argp = 1193180/frequência). argp = 0 desliga o som. Em ambos os casos, o controle retorna imediatamente.
Obtém o atual mapa de cores padrão a partir do kernel. argp aponta para um vetor de 48 bytes. (Desde o Linux 1.3.3.)
Altera o mapa de cores padrão no modo texto. argp aponta para um vetor de 48 bytes o qual contém, em ordem, os valores Vermelho, Verde, e Azul para as 16 cores disponíveis da tela: 0 é desligado, e 255 é intensidade máxima. As cores padrão são, em ordem: preto, vermelho escuro, verde escuro, marrom, azul escuro, violeta escuro, ciano escuro, cinza claro, cinza escuro, vermelho brilhante, verde brilhante, amarelo, azul brilhante, violeta brilhante, ciano brilhante e branco. (Desde o Linux 1.3.3.)
Obtém os 256 caracteres da fonte da tela em forma expandida. argp aponta para um vetor de 8192 bytes. Falha com código de erro EINVAL se a fonte atualmente carregado é uma fonte de 512 caracteres, ou se o console não está em modo texto.
Obtém a fonte da tela e informações associadas. argp aponta para um struct consolefontdesc (consulte PIO_FONTX). Na chamada, o campo charcount deve ser definido para o número máximo de caracteres que caberia no buffer apontado por chardata. No retorno, o charcount e charheight são preenchidos com os respectivos dados para a fonte atualmente carregada, e o vetor chardata contém o dados da fonte se o valor inicial de charcount indicava espaço suficiente disponível; caso contrário, o buffer fica intocado e errno é definido com ENOMEM. (Desde o Linux 1.3.1.)
Define uma fonte da tela de 256 caracteres. Carrega a fonte dentro do gerador de caracteres EGA/VGA. argp aponta para um mapa de bits de 8192, com 32 bytes por caractere. Somente o primeiro N deles são usados para uma fonte 8xN (0 < N <= 32). Esta chamada também elimina o mapeamento Unicode.
Define a fonte da tela e associa informações de desenho. argp aponta para um

struct consolefontdesc {

unsigned short charcount; /* caracteres na fonte
(256 ou 512) */
unsigned short charheight; /* linhas rastreadas
por caracteres (1-32) */
char *chardata; /* dados da fonte em
forma expandida */ };

Se necessário a tela será apropriadamente redimensionada, e SIGWINCH enviada para o processo apropriado. Esta chamada também elimina o mapeamento Unicode. (Desde o Linux 1.3.1.)
Redefine o fonte da tela, tamanho e mapeamento Unicode para a inicialização padrão. argp não é usado, mas seria definido para NULL para assegurar compatibilidade com futuras versões do Linux. (Desde o Linux 1.3.28.)
Obtém o mapeamento da tela a partir do kernel. argp aponta para uma área de tamanho E_TABSZ, o qual é carregado com a posicionamento da fonte usada para exibir cada caractere. Esta chamada é provavelmente para retornar informações imprestáveis se a fonte atualmente carregada é maior que 256 caracteres.
Obtém o mapeamento completo Unicode da tela a partir do kernel. argp aponta para uma área de tamanho E_TABSZ*sizeof(unsigned short), o qual é carregado com a representação Unicode de cada caractere. Um conjunto especial de Unicode, começando em U+F000, é usado para representar o mapeamento "direto para a fonte". (Desde o Linux 1.3.1.)
Carrega a (quarta) tabela "definível pelo usuário" no kernel o qual mapeia bytes dentro dos símbolos da tela da console. argp aponta para uma área de tamanho E_TABSZ.
Carrega a (quarta) tabela “definível pelo usuário” no kernel a qual mapeia bytes dentro dos Unicodes, o qual são então traduzidos em símbolos da tela de acordo com o mapa atualmente carregado de Unicode para fonte. Unicodes especiais iniciam em U+F000 e podem ser usados para mapear diretamente para os símbolos da fonte. (Desde o Linux 1.3.1.)
Obtém o mapeamento Unicode para fonte a partir do kernel. argp aponta para uma

struct unimapdesc {

unsigned short entry_ct;
struct unipair *entries; };

onde entries aponta para um vetor de

struct unipair {

unsigned short unicode;
unsigned short fontpos; };

(Desde o Linux 1.1.92.)
Coloca o mapeamento Unicode para fonte no kernel. argp aponta para uma struct unimapdesc. (Desde o Linux 1.1.92)
Limpa a tabela, possivelmente aconselha um algoritmo de hash. argp aponta para uma

struct unimapinit {

unsigned short advised_hashsize; /* 0 se não tem opinião */
unsigned short advised_hashstep; /* 0 se não tem opinião */
unsigned short advised_hashlevel; /* 0 se não tem opinião */ };

(Desde o Linux 1.1.92.)
Obtém o modo atual do teclado. argp aponta para um long o qual é definido para um destes:
K_RAW 0x00 /* Modo bruto (scancode) */
K_XLATE 0x01 /* Traduz códigos de tecla usando mapa de teclado */
K_MEDIUMRAW 0x02 /* Modo bruto médio (scancode) */
K_UNICODE 0x03 /* Modo Unicode */
K_OFF 0x04 /* Modo desabilitado; desde o Linux 2.6.39 */
Define o modo atual do teclado. argp é um long igual a um dos valores mostrados para KDGKBMODE.
Obtém o modo de manipulação da tecla meta. argp aponta para um long o qual é define para um destes:
K_METABIT 0x03 define bit de alta ordem
K_ESCPREFIX 0x04 prefixo de escape
Define o modo de manipulação da tecla meta. argp é um long igual a um dos valores mostras acima para KDGKBMETA.
Obtém uma entrada na tabela de translação da tecla (código de tecla para código de ação). argp aponta para uma

struct kbentry {

unsigned char kb_table;
unsigned char kb_index;
unsigned short kb_value; };

com o primeiro dos dos membros preenchido em: kb_table seleciona a tabela de tecla (0 <= kb_table < MAX_NR_KEYMAPS), e kb_index é o código de tecla (0 <= kb_index < NR_KEYS). kb_value é define para o código de ação correspondente, ou K_HOLE se não existe tal tecla, ou K_NOSUCHMAP se kb_table é invalido.
Define uma entrada na tabela de tradução. argp aponta para uma struct kbentry.
Obtém uma string tecla de função. argp aponta para uma

struct kbsentry {

unsigned char kb_func;
unsigned char kb_string[512]; };

kb_string é definida para a string (com terminação NULA) correspondente ao código de ação da kb_func-ésima tecla de função.
Define a entrada de string para uma tecla de função. argp aponta para uma struct kbsentry.
Lê a tabela de acentuação do kernel. argp aponta para uma

struct kbdiacrs {

unsigned int kb_cnt;
struct kbdiacr kbdiacr[256]; };

onde kb_cnt é o número de entradas no vetor, cada qual é uma

struct kbdiacr {

unsigned char diacr;
unsigned char base;
unsigned char result; };

Lê a tabela de entrada código de tecla do kernel (código de varredura para código de tecla). argp aponta para uma

struct kbkeycode {

unsigned int scancode;
unsigned int keycode; };

O código de tecla keycode é definido para corresponder ao código de varredura scancode fornecido. (89 <= scancode <= 255 somente. Para 1 <= scancode <= 88, keycode==scancode.) (Desde o Linux 1.1.63.)
Escreve no kernel a entrada da tabela de códigos de tecla. argp aponta para uma estrutura kbkeycode. (Desde o Linux 1.1.63.)
O processo chamante indicado dele concordância para aceita o sinal argp quando ele é gerado pelo pressionamento de uma combinação de teclas apropriadas. (1 <= argp <= NSIG). (Veja spawn_console() em linux/drivers/char/keyboard.c.)
Retorna o primeiro console disponível (fechado). argp aponta para um int o qual é definido com um número de vt (1 <= *argp <= MAX_NR_CONSOLES).
Obtém o modo de ativação do vt. argp aponta para uma

struct vt_mode {

char mode; /* modo vt */
char waitv; /* se definida, trava em escritas se não está ativo */
short relsig; /* sinal para aumentar na liberação da requisição */
short acqsig; /* sinal para aumentar na aquisição */
short frsig; /* sem uso (definido para 0) */ };

que é definido para o modo do vt ativo. mode é definido para um destes valores:
VT_AUTO troca automática de vt
VT_PROCESS troca de controles de processo
VT_ACKACQ reconhece a troca
Define o modo de ativação do vt. argp aponta para uma struct vt_mode.
Obtém a informação global do estado de vt. argp aponta para uma

struct vt_stat {

unsigned short v_active; /* vt ativo */
unsigned short v_signal; /* sinal para enviar */
unsigned short v_state; /* máscara de bits do vt */ };

Para cada vt em uso, o bit correspondente no membro v_state é definido. (Kernels 1.0 até 1.1.92.)
Libera um monitor.
Troca para o vt argp (1 <= argp <= MAX_NR_CONSOLES).
Aguarda até o vt argp ser ativado.
Desaloca a memória associada com o vt argp. (Desde o Linux 1.1.54.)
Definido o tamanho ideal da tela do kernel. argp aponta para um

struct vt_sizes {

unsigned short v_rows; /* # linhas */
unsigned short v_cols; /* # colunas */
unsigned short v_scrollsize; /* não usado mais */ };

Note que isto não é alterado para o modo de vídeo. Veja resizecons(8). (Desde o Linux1.1.54.)
Define os vários parâmetros ideais da tela do kernel. argp aponta para um

struct vt_consize {

unsigned short v_rows; /* número de linhas */
unsigned short v_cols; /* número de colunas */
unsigned short v_vlin; /* número de linhas de pixel
na tela */
unsigned short v_clin; /* número de linhas de pixel
por caractere */
unsigned short v_vcol; /* número de colunas de pixel
na tela */
unsigned short v_ccol; /* número de colunas de pixel
por caractere */ };

Qualquer parâmetro pode ser definido para zero, indicando "nenhuma alteração", mas se vários parâmetros são alterados, eles devem ser consistentes. Note que isto não mudou o modo de video. Veja resizecons(8). (Desde o Linux 1.3.3.)

A ação das seguintes ioctls dependia do primeiro byte na estrutura apontada pelo argp, referido aqui como o subcode. Estes são somente válido para o superusuário ou o proprietário do tty atual.

Esvazia a tela. Desapareceu no Linux 1.1.92. (Com o kernel 1.1.92 ou posterior, lê a partir de /dev/vcsN ou /dev/vcsaN.)
Obtém a informação da tarefa. Desapareceu no Linux 1.1.92.
Define a seleção. argp aponta para uma

struct {

char subcode;
short xs, ys, xe, ye;
short sel_mode; };

xs e ys estão começando as colunas e linhas. xe e ye estão terminando as colunas e linhas. (O canto superior esquerdo é a linha=coluna=1.) sel_mode é 0 para uma seleção caractere por caractere, 1 para uma seleção palavra por palavra, ou 2 para uma seleção linha por linha. Os caracteres indicados na tela são brilhantes e guardados no vetor estático sel_buffer em devices/char/console.c.
Cola a seleção. Os caracteres no buffer de seleção são escritos para fd.
Tela não vazia.
Define o conteúdo de uma tabela de visualização de caracteres de 256 bits definida em uma "palavra", para seleção palavra por palavra. (Desde o Linux 1.1.32.)
argp aponta para um caractere, o qual é define com o valor da variável do kernel shift_state. (Desde o Linux 1.1.32.)
argp aponta para um caractere o qual é definido para o valor da variável do kernel report_mouse. (Desde o Linux 1.1.33.)
Esvazia largura e altura da tela, posição do cursor, e todos os pares de atributos de caracteres. (Somente os kernels 1.1.67 até 1.1.91. Com o kernel 1.1.92 ou mais novos, lê a partir /dev/vcsa*.)
Restaura largura e altura da tela, posição do cursor, e todos os pares de atributos de caracteres. (Somente os kernels 1.1.67 até 1.1.91. Com o kernel 1.1.92 ou mais novos, lê a partir /dev/vcsa*.)
Manipula a característica de economia de energia da nova geração de monitores. O modo de esvaziamento de tela VESA é definido para argp[1], o qual gerencia o que esvaziamento de tela fará:
0:
Esvaziamento de tela é desabilitado.
1:
As configurações de registro do atual adaptador de vídeo são guardadas, então o controlador é programado para desligar os pulsos de sincronização vertical. Isto coloca o monitor em modo "standby". Se o monitor tiver um temporizador Off_Mode, então ele irá eventualmente desligar a si próprio.
2:
As configurações atuais são guardadas, então ambos os pulsos de sincronização vertical e horizontal são desligados. Isto coloca o monitor em modo "off". Se o monitor tem um temporizador Off_Mode, ou se você deseja que seu monitor desligue imediadamente quando o tempo de blank_timer termina, então escolha esta opção. (Cuidado: Desligar o monitor com frequência irá danificar o monitor.) (Desde o Linux 1.1.76.)

Em caso de sucesso, 0 é retornado. Caso contrário, -1 é retornado, e errno é definido para indicar o erro.

O descritor de arquivo é inválido.
O descritor de arquivo ou argp é invalido.
Um descritor de arquivo não está associado com um dispositivo especial de caractere, ou a requisição especificada não se aplica a ele.
Permissão insuficiente.

Aviso: Não considere esta página man como documentação das chamadas de console ioctls do Linux. Isto é fornecido para curiosos somente, com uma alternativa a estudar o código-fonte. Ioctls são chamadas não documentadas do Linux, propensas a serem alteradas sem nenhum aviso. (E, de fato, esta página descreve mais ou menos a situação da versão do kernel 1.1.94; há muitas diferenças pequenas e não tão pequenas com as versão mais recentes.)

Muito frequentemente, ioctls são introduzidos para comunicação ente o kernel e um programa particular bem conhecido, (fdisk, hdparm, setserial, tunelp, loadkeys, selection, setfont etc.), e o comportamento deles será alterado quando requerido por este programa particular.

Programas usando estas ioctls podem não ser portáveis para outras versões de UNIX, podem não trabalhar em versões antigas do Linux, e podem não trabalhar nas futuras versões do Linux.

Usa as funções POSIX.

dumpkeys(1), kbd_mode(1), loadkeys(1), mknod(1), setleds(1), setmetamode(1), execve(2), fcntl(2), ioctl_tty(2), ioperm(2), termios(3), console_codes(4), mt(4), sd(4), tty(4), ttyS(4), vcs(4), vcsa(4), charsets(7), mapscrn(8), resizecons(8), setfont(8)

/usr/include/linux/kd.h, /usr/include/linux/vt.h

Esta página faz parte da versão 5.13 do projeto Linux man-pages. Uma descrição do projeto, informações sobre relatórios de bugs e a versão mais recente desta página podem ser encontradas em https://www.kernel.org/doc/man-pages/.

A tradução para português brasileiro desta página man foi criada por André Luiz Fassone <lonely_wolf@ig.com.br>, Carlos Augusto Horylka <horylka@conectiva.com.br> e Rafael Fontenelle <rafaelff@gnome.org>.

Esta tradução é uma documentação livre; leia a Licença Pública Geral GNU Versão 3 ou posterior para as condições de direitos autorais. Nenhuma responsabilidade é aceita.

Se você encontrar algum erro na tradução desta página de manual, envie um e-mail para a lista de discussão de tradutores.

22 março 2021 Linux