tpic6c595.h

#ifndef TPIC6C595_TPIC6C595_H
#define TPIC6C595_TPIC6C595_H

/**
 * Configures the mode of the button, e.g. to any of TPIC6C595_MODE_BTN_*.
 */
#define TPIC6C595_IOCTL_BTN _IO(0xaa, 0x00)

/**
 * The button has no functionality.
 */
#define TPIC6C595_MODE_BTN_DISABLED 0

/**
 * Pressing the button results in chase of values, this gives a "knightrider"-effect.
 */
#define TPIC6C595_MODE_BTN_CHASER   1

/**
 * Pressing the button results in the device being flushed by zeroes and ones which
 * gives a blinking/flashing effect.
 */
#define TPIC6C595_MODE_BTN_FLASH    2

/**
 * Pressing the button clears the device by flushing it with zeroes.
 */
#define TPIC6C595_MODE_BTN_CLEAR    3

/**
 * Sets the bitbang delay, e.g. the time to wait between state-changes of
 * the gpio-line in microseconds.
 */
#define TPIC6C595_IOCTL_BITBANG_DELAY _IO(0xaa, 0x01)

/**
 * Sets the effect-duration of the button in milliseconds. E.g. the time in milliseconds
 * between flashes when the button is configured to flash the device.
 */
#define TPIC6C595_IOCTL_EFFECT_DURATION _IO(0xaa, 0x02)

/**
 * Sets the drivers assumed size of the the devices in bytes. E.g. one single
 * TPIC6C595 is one byte long but they can be daisy-chained so two tpics
 * will be two bytes long etc.
 */
#define TPIC6C595_IOCTL_SIZE _IO(0xaa, 0x03)

/**
 * Sets the nth bit of the device. All other bits remain untouched.
 */
#define TPIC6C595_BIT_SET _IOW(0xaa, 0x04)

/**
 * Unsets the nth bit of the device. All other bits remain untouched.
 */
#define TPIC6C595_BIT_UNSET _IOW(0xaa, 0x05)

#endif //TPIC6C595_TPIC6C595_H