source: mainline/uspace/drv/char/i8042/i8042.h@ b9cc81c6

/*
 * Copyright (c) 2024 Jiri Svoboda
 * Copyright (c) 2006 Josef Cejka
 * Copyright (c) 2011 Jan Vesely
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup i8042
 * @{
 */

/** @file
 * @brief i8042 port driver.
 */

#ifndef i8042_H_
#define i8042_H_

#include <adt/circ_buf.h>
#include <io/chardev_srv.h>
#include <ddi.h>
#include <fibril_synch.h>
#include <ddf/driver.h>

#define NAME  "i8042"

/** Buffer needs to be large enough for rate at which keyboard or mouse
 * produces data (mouse produces data at faster rate).
 */
#define BUFFER_SIZE  64

/** i8042 HW I/O interface */
typedef struct {
        ioport8_t data;
        uint8_t pad[3];
        ioport8_t status;
} __attribute__((packed)) i8042_regs_t;

/** i8042 Port. */
typedef struct {
        /** Controller */
        struct i8042 *ctl;
        /** Device function */
        ddf_fun_t *fun;
        /** Character device server data */
        chardev_srvs_t cds;
        /** Circular buffer */
        circ_buf_t cbuf;
        /** Buffer data space */
        uint8_t buf_data[BUFFER_SIZE];
        /** Protect buffer */
        fibril_mutex_t buf_lock;
        /** Signal new data in buffer */
        fibril_condvar_t buf_cv;
        /** Interrupt number */
        int irq;
} i8042_port_t;

/** i8042 Controller. */
typedef struct i8042 {
        /** DDF device */
        ddf_dev_t *dev;
        /** I/O registers. */
        i8042_regs_t *regs;
        /** Keyboard port */
        i8042_port_t *kbd;
        /** AUX port */
        i8042_port_t *aux;
        /** Prevents simultanous port writes. */
        fibril_mutex_t write_guard;
} i8042_t;

extern errno_t i8042_init(i8042_t *, addr_range_t *, int, int, ddf_dev_t *);

#endif

/**
 * @}
 */