kbd.h

Go to the documentation of this file.

#pragma once
 
#include <kernel/fs/devfs.h>
#include <kernel/sched/wait.h>
#include <kernel/sync/lock.h>
#include <kernel/utils/fifo.h>
 
#include <stdint.h>
#include <sys/kbd.h>
#include <sys/proc.h>
 
typedef struct kbd kbd_t;
 
/**
 * @brief Keyboard abstraction.
 * @defgroup kernel_drivers_abstract_kbd Keyboard Abstraction
 * @ingroup kernel_drivers_abstract
 *
 * Keyboard devices are exposed as a `/dev/kbd/[id]/` directory, containing the below files.
 *
 * ## name
 *
 * A read-only file that contains the driver defined name of the keyboard device.
 *
 * ## events
 *
 * A readable and pollable file that provides a stream of keyboard events represented as integer keycodes suffixed with
 * a `_` or `^` to indicate press or release respectively.
 *
 * The below example shows a press of the `1` key, its subsequent release, and then a press of the `A` key.
 *
 * ```
 * 30_30^5_
 * ```
 *
 * If no events are available to read, the read call will block until an event is available unless the file is opened in
 * non-blocking mode in which case the read will fail with `EAGAIN`.
 *
 * @note The format is specified such that if `scan()` is used with "%u%c" the `scan()` call does not require any
 * "ungets".
 *
 * @see libstd_sys_kbd for keycode definitions.
 *
 * @{
 */
 
/**
 * @brief Size of the keyboard client buffer.
 */
#define KBD_CLIENT_BUFFER_SIZE 512
 
/**
 * @brief Keyboard event client structure.
 * @struct kbd_client_t
 */
typedef struct kbd_client
{
    list_entry_t entry;
    fifo_t fifo;
    uint8_t buffer[KBD_CLIENT_BUFFER_SIZE];
} kbd_client_t;
 
/**
 * @brief Keyboard structure.
 * @struct kbd_t
 */
typedef struct kbd
{
    char name[MAX_PATH];
    wait_queue_t waitQueue;
    list_t clients;
    lock_t lock;
    dentry_t* dir;
    list_t files;
} kbd_t;
 
/**
 * @brief Allocate and initialize a new keyboard.
 *
 * @param name The driver specified name of the keyboard.
 * @return On success, the new keyboard. On failure, `NULL` and `errno` is set.
 */
kbd_t* kbd_new(const char* name);
 
/**
 * @brief Frees a keyboard.
 *
 * @param kbd The keyboard to free.
 */
void kbd_free(kbd_t* kbd);
 
/**
 * @brief Push a keyboard press event to the keyboard event queue.
 *
 * @param kbd The keyboard.
 * @param type The type of event.
 * @param code The keycode of the event.
 */
void kbd_press(kbd_t* kbd, keycode_t code);
 
/**
 * @brief Push a keyboard release event to the keyboard event queue.
 *
 * @param kbd The keyboard.
 * @param code The keycode to release.
 */
void kbd_release(kbd_t* kbd, keycode_t code);
 
/** @} */