LXR linux/include/linux/libps2.h

   1/* SPDX-License-Identifier: GPL-2.0-only */
   2#ifndef _LIBPS2_H
   3#define _LIBPS2_H
   4
   5/*
   6 * Copyright (C) 1999-2002 Vojtech Pavlik
   7 * Copyright (C) 2004 Dmitry Torokhov
   8 */
   9
  10#include <linux/bitops.h>
  11#include <linux/mutex.h>
  12#include <linux/types.h>
  13#include <linux/wait.h>
  14
  15#define PS2_CMD_SETSCALE11      0x00e6
  16#define PS2_CMD_SETRES          0x10e8
  17#define PS2_CMD_GETID           0x02f2
  18#define PS2_CMD_RESET_BAT       0x02ff
  19
  20#define PS2_RET_BAT             0xaa
  21#define PS2_RET_ID              0x00
  22#define PS2_RET_ACK             0xfa
  23#define PS2_RET_NAK             0xfe
  24#define PS2_RET_ERR             0xfc
  25
  26#define PS2_FLAG_ACK            BIT(0)  /* Waiting for ACK/NAK */
  27#define PS2_FLAG_CMD            BIT(1)  /* Waiting for a command to finish */
  28#define PS2_FLAG_CMD1           BIT(2)  /* Waiting for the first byte of command response */
  29#define PS2_FLAG_WAITID         BIT(3)  /* Command executing is GET ID */
  30#define PS2_FLAG_NAK            BIT(4)  /* Last transmission was NAKed */
  31#define PS2_FLAG_ACK_CMD        BIT(5)  /* Waiting to ACK the command (first) byte */
  32
  33struct ps2dev {
  34        struct serio *serio;
  35
  36        /* Ensures that only one command is executing at a time */
  37        struct mutex cmd_mutex;
  38
  39        /* Used to signal completion from interrupt handler */
  40        wait_queue_head_t wait;
  41
  42        unsigned long flags;
  43        u8 cmdbuf[8];
  44        u8 cmdcnt;
  45        u8 nak;
  46};
  47
  48void ps2_init(struct ps2dev *ps2dev, struct serio *serio);
  49int ps2_sendbyte(struct ps2dev *ps2dev, u8 byte, unsigned int timeout);
  50void ps2_drain(struct ps2dev *ps2dev, size_t maxbytes, unsigned int timeout);
  51void ps2_begin_command(struct ps2dev *ps2dev);
  52void ps2_end_command(struct ps2dev *ps2dev);
  53int __ps2_command(struct ps2dev *ps2dev, u8 *param, unsigned int command);
  54int ps2_command(struct ps2dev *ps2dev, u8 *param, unsigned int command);
  55int ps2_sliced_command(struct ps2dev *ps2dev, u8 command);
  56bool ps2_handle_ack(struct ps2dev *ps2dev, u8 data);
  57bool ps2_handle_response(struct ps2dev *ps2dev, u8 data);
  58void ps2_cmd_aborted(struct ps2dev *ps2dev);
  59bool ps2_is_keyboard_id(u8 id);
  60
  61#endif /* _LIBPS2_H */
  62