blob: 7561954f755d727545705354fd09dec5a6f06693 [file] [log] [blame] [edit]
#ifndef __KEYBOARD_H
#define __KEYBOARD_H
#include <input.h>
#include <stdio_dev.h>
/**
* struct keyboard_priv - information about a keyboard, for the uclass
*
* @sdev: stdio device
* @input: input configuration (the driver may use this if desired)
*/
struct keyboard_priv {
struct stdio_dev sdev;
/*
* This is set up by the uclass but will only be used if the driver
* sets input.dev to its device pointer (it is initially NULL).
*/
struct input_config input;
};
/**
* struct keyboard_ops - keyboard device operations
*/
struct keyboard_ops {
/**
* start() - enable the keyboard ready for use
*
* @dev: Device to enable
* @return 0 if OK, -ve on error
*/
int (*start)(struct udevice *dev);
/**
* stop() - disable the keyboard when no-longer needed
*
* @dev: Device to disable
* @return 0 if OK, -ve on error
*/
int (*stop)(struct udevice *dev);
/**
* tstc() - check if a key is available
*
* @dev: Device to check
* @return 0 if no key is available, 1 if a key is available, -ve on
* error
*/
int (*tstc)(struct udevice *dev);
/**
* getc() - get a key
*
* TODO(sjg@chromium.org): At present this method may wait if it calls
* input_getc().
*
* @dev: Device to read from
* @return -EAGAIN if no key is available, otherwise key value read
* (as ASCII).
*/
int (*getc)(struct udevice *dev);
/**
* update_leds() - update keyboard LEDs
*
* This is called when the LEDs have changed and need to be updated.
* For example, if 'caps lock' is pressed then this method will be
* called with the new LED value.
*
* @dev: Device to update
* @leds: New LED mask (see INPUT_LED_... in input.h)
*/
int (*update_leds)(struct udevice *dev, int leds);
};
#define keyboard_get_ops(dev) ((struct keyboard_ops *)(dev)->driver->ops)
#endif /* __KEYBOARD_H */