KSREGRING (Register Input Ring)

Purpose

Registers input ring.

Syntax

#include <sys/inputdd.h>

int ioctl (FileDescriptor, KSREGRING, Arg)
int FileDescriptor;
caddr_t *Arg;

Description

If the keyboard special file was opened by a process in user mode, the Arg parameter should point to a uregring structure containing:

• A pointer to an input ring in user memory.
• The value to be used as the source identifier when enqueuing reports on the ring.
• The size of the input ring in bytes.

If the keyboard special file was opened by a process in kernel mode, the Arg parameter should point to a kregring structure containing:

• A pointer to an input ring in pinned kernel memory.
• The value to be used as the source identifier when enqueuing reports on the ring.
• A pointer to the notification callback routine. The callback is invoked following the occurrence of an event as specified via the ir_notify field in the input ring structure.
• A pointer to the secure attention key (SAK) callback routine. The callback is invoked following the occurrence of a SAK (Ctrl x-r) when SAK detection is enabled.

All callbacks execute within the interrupt environment. All fields within the input ring header as defined by the input ring structure must be properly initialized before the invocation of the ioctl. A subsequent KSREGRING ioctl subroutine call replaces the input ring supplied earlier. Specify a null input ring pointer to disable keyboard input.

The input ring acts as a buffer for operator input. Key press and release events are placed on the ring as they occur, without processing or filtering.

Parameters

Implementation Specifics

This ioctl subroutine call is part of Base Operating System (BOS) Runtime.