libratbag/src/libratbag-private.h

/*
 * Copyright © 2015 Red Hat, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#pragma once

#include "config.h"
#include <linux/input.h>
#include <stdint.h>
#include <stdbool.h>
#include <assert.h>

#include "libratbag.h"
#include "libratbag-util.h"
#include "libratbag-hidraw.h"

#ifdef NDEBUG
#error "libratbag relies on assert(). Do not define NDEBUG"
#endif

#define RATBAG_LED_TYPE_UNKNOWN 0

void
log_msg_va(struct ratbag *ratbag,
	   enum ratbag_log_priority priority,
	   const char *format,
	   va_list args)
	LIBRATBAG_ATTRIBUTE_PRINTF(3, 0);
void log_msg(struct ratbag *ratbag,
	enum ratbag_log_priority priority,
	const char *format, ...)
	LIBRATBAG_ATTRIBUTE_PRINTF(3, 4);
void
log_buffer(struct ratbag *ratbag,
	enum ratbag_log_priority priority,
	const char *header,
	uint8_t *buf, size_t len);

#define log_raw(li_, ...) log_msg((li_), RATBAG_LOG_PRIORITY_RAW, __VA_ARGS__)
#define log_debug(li_, ...) log_msg((li_), RATBAG_LOG_PRIORITY_DEBUG, __VA_ARGS__)
#define log_info(li_, ...) log_msg((li_), RATBAG_LOG_PRIORITY_INFO, __VA_ARGS__)
#define log_error(li_, ...) log_msg((li_), RATBAG_LOG_PRIORITY_ERROR, __VA_ARGS__)
#define log_bug_kernel(li_, ...) log_msg((li_), RATBAG_LOG_PRIORITY_ERROR, "kernel bug: " __VA_ARGS__)
#define log_bug_libratbag(li_, ...) log_msg((li_), RATBAG_LOG_PRIORITY_ERROR, "libratbag bug: " __VA_ARGS__)
#define log_bug_client(li_, ...) log_msg((li_), RATBAG_LOG_PRIORITY_ERROR, "client bug: " __VA_ARGS__)
#define log_buf_raw(li_, h_, buf_, len_) log_buffer(li_, RATBAG_LOG_PRIORITY_RAW, h_, buf_, len_)
#define log_buf_debug(li_, h_, buf_, len_) log_buffer(li_, RATBAG_LOG_PRIORITY_DEBUG, h_, buf_, len_)
#define log_buf_info(li_, h_, buf_, len_) log_buffer(li_, RATBAG_LOG_PRIORITY_INFO, h_, buf_, len_)
#define log_buf_error(li_, h_, buf_, len_) log_buffer(li_, RATBAG_LOG_PRIORITY_ERROR, h_, buf_, len_)

static inline void
cleanup_device(struct ratbag_device **d)
{
	ratbag_device_unref(*d);
}

static inline void
cleanup_profile(struct ratbag_profile **p)
{
	ratbag_profile_unref(*p);
}

static inline void
cleanup_resolution(struct ratbag_resolution **r)
{
	ratbag_resolution_unref(*r);
}

static inline void
cleanup_button(struct ratbag_button **b)
{
	ratbag_button_unref(*b);
}

static inline void
cleanup_led(struct ratbag_led **l)
{
	ratbag_led_unref(*l);
}

#define _cleanup_device_ _cleanup_(cleanup_device)
#define _cleanup_profile_ _cleanup_(cleanup_profile)
#define _cleanup_resolution_ _cleanup_(cleanup_resolution)
#define _cleanup_button_ _cleanup_(cleanup_button)
#define _cleanup_led_ _cleanup_(cleanup_led)

#define BUS_ANY					0xffff
#define VENDOR_ANY				0xffff
#define PRODUCT_ANY				0xffff
#define VERSION_ANY				0xffff

/* This struct is used by the test suite only */
struct ratbag_test_device;

struct ratbag_driver;
struct ratbag_button_action;

struct ratbag {
	const struct ratbag_interface *interface;
	void *userdata;

	struct udev *udev;
	struct list drivers;
	struct list devices;

	int refcount;
	ratbag_log_handler log_handler;
	enum ratbag_log_priority log_priority;
};

#define MAX_CAP 1000

struct ratbag_device {
	char *name;
	void *userdata;

	struct udev_device *udev_device;
	struct ratbag_hidraw hidraw[MAX_HIDRAW];
	int refcount;
	struct input_id ids;
	struct ratbag_driver *driver;
	struct ratbag *ratbag;
	struct ratbag_device_data *data;

	unsigned num_profiles;
	struct list profiles;

	unsigned num_buttons;
	unsigned num_leds;

	void *drv_data;

	struct list link;
};

/**
 * struct ratbag_driver - user space driver for a ratbag device
 */
struct ratbag_driver {
	/** A human-readable name of the driver */
	char *name;

	/** The id of the driver used to match with RATBAG_DRIVER in udev */
	char *id;

	/**
	 * Callback called while trying to open a device by libratbag.
	 * This function should decide whether or not this driver will
	 * handle the given device.
	 *
	 * Return -ENODEV to ignore the device and let other drivers
	 * probe the device. Any other error code will stop the probing.
	 *
	 * If a matching driver is found it should initialize itself
	 * and synchronize all profiles with the current state on the device
	 * in this callback.
	 */
	int (*probe)(struct ratbag_device *device);

	/**
	 * Callback called right before the struct ratbag_device is
	 * unref-ed.
	 *
	 * In this callback, the extra memory allocated in probe should
	 * be freed.
	 */
	void (*remove)(struct ratbag_device *device);

	/**
	 * Callback called when the driver should write any profiles that
	 * were modified back to the device.
	 *
	 * Both profile and button structs have a dirty variable that can
	 * be used to tell whether or not they've actually changed since
	 * the last commit. In order to reduce the amount of time
	 * committing takes, drivers should use this information to avoid
	 * writing back profiles and buttons that haven't actually changed.
	 */
	int (*commit)(struct ratbag_device *device);

	/*
	 * FIXME: This function is deprecated and should be removed. Once
	 * we've updated all the device drivers to stop using it we'll remove
	 * it. Look at commit() instead.
	 */
	int (*write_profile)(struct ratbag_profile *profile);

	/**
	 * Called to mark a previously writen profile as active.
	 *
	 * There should be no need to write the profile here, a
	 * .write_profile() call is issued before calling this.
	 */
	int (*set_active_profile)(struct ratbag_device *device, unsigned int index);

	/*
	 * FIXME: This function is deprecated and should be removed. Once
	 * we've updated all the device drivers to stop using it we'll remove
	 * it. Look at commit() instead.
	 */
	int (*write_button)(struct ratbag_button *button,
			    const struct ratbag_button_action *action);

	/*
	 * FIXME: This function is deprecated and should be removed. Once
	 * we've updated all the device drivers to stop using it we'll remove
	 * it. Look at commit() instead.
	 */
	int (*write_resolution_dpi)(struct ratbag_resolution *resolution,
				    int dpi_x, int dpi_y);

	/*
	 * FIXME: This function is deprecated and should be removed. Once
	 * we've updated all the device drivers to stop using it we'll remove
	 * it. Look at commit() instead.
	 */
	int (*write_led)(struct ratbag_led *led, enum ratbag_led_mode mode,
			 struct ratbag_color color, unsigned int ms,
			 unsigned int brightness);

	/* private */
	int (*test_probe)(struct ratbag_device *device, const void *data);

	struct list link;
};

struct ratbag_resolution {
	struct ratbag_profile *profile;
	int refcount;
	void *userdata;
	struct list link;
	unsigned index;

	unsigned int dpis[300];
	size_t ndpis;

	unsigned int dpi_x;	/**< x resolution in dpi */
	unsigned int dpi_y;	/**< y resolution in dpi */


	bool is_active;
	bool is_default;
	bool dirty;
	uint32_t capabilities;
};

struct ratbag_led {
	int refcount;
	void *userdata;
	struct list link;
	struct ratbag_profile *profile;
	unsigned index;
	enum ratbag_led_type type;
	enum ratbag_led_mode mode;
	uint32_t modes;		      /**< supported modes */
	struct ratbag_color color;
	enum ratbag_led_colordepth colordepth;
	unsigned int ms;              /**< duration of action in ms */
	unsigned int brightness;      /**< brightness of the LED */
	bool dirty;
};

struct ratbag_profile {
	int refcount;
	void *userdata;
	char *name;

	struct list link;
	unsigned index;
	struct ratbag_device *device;
	struct list buttons;
	void *drv_data;
	void *user_data;
	struct list resolutions;
	struct list leds;

	unsigned int hz;	/**< report rate in Hz */
	unsigned int rates[8];	/**< report rates available */
	size_t nrates;		/**< number of entries in rates */
	bool rate_dirty;

	unsigned int num_resolutions;

	bool is_active;		/**< profile is the currently active one */
	bool is_enabled;
	bool dirty;       /**< profile changed since last commit */
	unsigned long capabilities[NLONGS(MAX_CAP)];
};

#define ratbag_device_for_each_profile(device_, profile_) \
	list_for_each(profile_, &(device_)->profiles, link)

#define ratbag_profile_for_each_button(profile_, button_) \
	list_for_each(button_, &(profile_)->buttons, link) \

#define ratbag_profile_for_each_led(profile_, led_) \
	list_for_each(led_, &(profile_)->leds, link)

#define ratbag_profile_for_each_resolution(profile_, resolution_) \
	list_for_each(resolution_, &(profile_)->resolutions, link)

#define BUTTON_ACTION_NONE \
 { .type = RATBAG_BUTTON_ACTION_TYPE_NONE }
#define BUTTON_ACTION_BUTTON(num_) \
 { .type = RATBAG_BUTTON_ACTION_TYPE_BUTTON, \
	.action.button = num_ }
#define BUTTON_ACTION_SPECIAL(sp_) \
 { .type = RATBAG_BUTTON_ACTION_TYPE_SPECIAL, \
	.action.special = sp_ }
#define BUTTON_ACTION_KEY(k_) \
 { .type = RATBAG_BUTTON_ACTION_TYPE_KEY, \
	.action.key.key = k_ }
#define BUTTON_ACTION_MACRO \
 { .type = RATBAG_BUTTON_ACTION_TYPE_MACRO, \
	/* FIXME: add the macro keys */ }

struct ratbag_macro_event {
	enum ratbag_macro_event_type type;
	union ratbag_macro_evnt {
		unsigned int key;
		unsigned int timeout;
	} event;
};

#define MAX_MACRO_EVENTS 256
struct ratbag_macro {
	char *name;
	char *group;
	struct ratbag_macro_event events[MAX_MACRO_EVENTS];
};

struct ratbag_button_macro {
	int refcount;
	struct ratbag_macro macro;
};

#define MODIFIER_LEFTCTRL (1 << 0)
#define MODIFIER_LEFTSHIFT (1 << 1)
#define MODIFIER_LEFTALT (1 << 2)
#define MODIFIER_LEFTMETA (1 << 3)
#define MODIFIER_RIGHTCTRL (1 << 4)
#define MODIFIER_RIGHTSHIFT (1 << 5)
#define MODIFIER_RIGHTALT (1 << 6)
#define MODIFIER_RIGHTMETA (1 << 7)

struct ratbag_button_action {
	enum ratbag_button_action_type type;
	union ratbag_btn_action {
		unsigned int button; /* action_type == button */
		enum ratbag_button_action_special special; /* action_type == special */
		struct {
			unsigned int key; /* action_type == key */
			/* FIXME: modifiers */
		} key;
	} action;
	struct ratbag_macro *macro; /* dynamically allocated, so kept aside */
};

struct ratbag_button {
	int refcount;
	void *userdata;
	struct list link;
	struct ratbag_profile *profile;
	unsigned index;
	enum ratbag_button_type type;
	struct ratbag_button_action action;
	uint32_t action_caps;
	bool dirty; /* changed since last commit to device */
};

void
ratbag_button_set_action(struct ratbag_button *button,
			 const struct ratbag_button_action *action);

static inline void
ratbag_button_enable_action_type(struct ratbag_button *button,
				 enum ratbag_button_action_type type)
{
	button->action_caps |= 1 << type;
}

static inline int
ratbag_open_path(struct ratbag_device *device, const char *path, int flags)
{
	struct ratbag *ratbag = device->ratbag;

	return ratbag->interface->open_restricted(path, flags, ratbag->userdata);
}

static inline void
ratbag_close_fd(struct ratbag_device *device, int fd)
{
	struct ratbag *ratbag = device->ratbag;

	return ratbag->interface->close_restricted(fd, ratbag->userdata);
}

static inline void
ratbag_set_drv_data(struct ratbag_device *device, void *drv_data)
{
	device->drv_data = drv_data;
}

static inline void *
ratbag_get_drv_data(const struct ratbag_device *device)
{
	return device->drv_data;
}

int
ratbag_device_init_profiles(struct ratbag_device *device,
			    unsigned int num_profiles,
			    unsigned int num_resolutions,
			    unsigned int num_buttons,
			    unsigned int num_leds);

static inline void
ratbag_profile_set_drv_data(struct ratbag_profile *profile, void *drv_data)
{
	profile->drv_data = drv_data;
}

static inline void *
ratbag_profile_get_drv_data(struct ratbag_profile *profile)
{
	return profile->drv_data;
}

static inline void
ratbag_profile_set_cap(struct ratbag_profile *profile,
		       enum ratbag_profile_capability cap)
{
	assert(cap <= MAX_CAP);

	long_set_bit(profile->capabilities, cap);
}

static inline int
ratbag_button_action_match(const struct ratbag_button_action *action,
			   const struct ratbag_button_action *match)
{
	if (action->type != match->type)
		return 0;

	switch (action->type) {
	case RATBAG_BUTTON_ACTION_TYPE_BUTTON:
		return match->action.button == action->action.button;
	case RATBAG_BUTTON_ACTION_TYPE_KEY:
		return match->action.key.key == action->action.key.key;
	case RATBAG_BUTTON_ACTION_TYPE_SPECIAL:
		return match->action.special == action->action.special;
	case RATBAG_BUTTON_ACTION_TYPE_MACRO:
		return 1;
	default:
		break;
	}

	return 0;
}

int
ratbag_action_macro_num_keys(struct ratbag_button_action *action);

int
ratbag_button_macro_new_from_keycode(struct ratbag_button *button,
				     unsigned int key,
				     unsigned int modifiers);

int
ratbag_action_keycode_from_macro(struct ratbag_button_action *action,
				     unsigned int *key_out,
				     unsigned int *modifiers_out);

static inline void
ratbag_resolution_set_resolution(struct ratbag_resolution *res,
				 int dpi_x, int dpi_y)
{
	res->dpi_x = dpi_x;
	res->dpi_y = dpi_y;
}

static inline void
ratbag_resolution_set_dpi_list_from_range(struct ratbag_resolution *res,
					  unsigned int min, unsigned int max)
{
	unsigned int stepsize = 50;
	unsigned int dpi = min;
	bool maxed_out = false;

	res->ndpis = 0;

	while (res->ndpis < ARRAY_LENGTH(res->dpis)) {
		if (dpi > (unsigned)max) {
			maxed_out = true;
			break;
		}

		res->dpis[res->ndpis] = dpi;
		res->ndpis++;

		if (dpi < 1000)
			stepsize = 50;
		else if (dpi < 2600)
			stepsize = 100;
		else if (dpi < 5000)
			stepsize = 200;
		else
			stepsize = 500;

		dpi += stepsize;
	}

	if (!maxed_out)
		log_bug_libratbag(res->profile->device->ratbag,
				  "%s: resolution range exceeds available space.\n",
				  res->profile->device->name);
}

static inline void
ratbag_resolution_set_dpi_list(struct ratbag_resolution *res,
			       unsigned int *dpis,
			       size_t ndpis)
{
	assert(ndpis <= ARRAY_LENGTH(res->dpis));
	_Static_assert(sizeof(*dpis) == sizeof(*res->dpis), "Mismatching size");

	for (size_t i = 0; i < ndpis; i++) {
		res->dpis[i] = dpis[i];
		if (i > 0)
			assert(dpis[i] > dpis[i - 1]);
	}
	res->ndpis = ndpis;
}

static inline void
ratbag_profile_set_report_rate_list(struct ratbag_profile *profile,
				    unsigned int *rates,
				    size_t nrates)
{
	assert(nrates <= ARRAY_LENGTH(profile->rates));
	_Static_assert(sizeof(*rates) == sizeof(*profile->rates), "Mismatching size");

	for (size_t i = 0; i < nrates; i++) {
		profile->rates[i] = rates[i];
		if (i > 0)
			assert(rates[i] > rates[i - 1]);
	}
	profile->nrates = nrates;
}

static inline void
ratbag_resolution_set_cap(struct ratbag_resolution *res,
			  enum ratbag_resolution_capability cap)
{
	assert(cap <= RATBAG_RESOLUTION_CAP_SEPARATE_XY_RESOLUTION);

	res->capabilities |= (1 << cap);
}

static inline void
ratbag_led_set_mode_capability(struct ratbag_led *led,
			       enum ratbag_led_mode mode)
{
	assert(mode <= RATBAG_LED_BREATHING);
	assert(mode < sizeof(led->modes) * 8);

	led->modes |= (1 << mode);
}

/* list of all supported drivers */
extern struct ratbag_driver etekcity_driver;
extern struct ratbag_driver hidpp20_driver;
extern struct ratbag_driver hidpp10_driver;
extern struct ratbag_driver logitech_g300_driver;
extern struct ratbag_driver logitech_g600_driver;
extern struct ratbag_driver roccat_driver;
extern struct ratbag_driver roccat_kone_pure_driver;
extern struct ratbag_driver gskill_driver;
extern struct ratbag_driver steelseries_driver;
extern struct ratbag_driver sinowealth_driver;
extern struct ratbag_driver sinowealth_nubwo_driver;
extern struct ratbag_driver openinput_driver;

struct ratbag_device*
ratbag_device_new(struct ratbag *ratbag, struct udev_device *udev_device,
		  const char *name, const struct input_id *id);
void
ratbag_device_destroy(struct ratbag_device *device);

const char *
ratbag_device_get_udev_property(const struct ratbag_device* device,
				const char *name);

bool
ratbag_assign_driver(struct ratbag_device *device,
		     const struct input_id *dev_id,
		     const struct ratbag_test_device *test_device);

void
ratbag_register_driver(struct ratbag *ratbag, struct ratbag_driver *driver);

void
ratbag_button_copy_macro(struct ratbag_button *button,
			 const struct ratbag_button_macro *macro);