/*
 * HECI-HID glue driver's definitions.
 *
 * Copyright (c) 2014-2015, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 */
#ifndef HECI_HID__H
#define	HECI_HID__H

/*
 * Constraint 1: currently we support only 1 ISS HW controller in a system
 */

const static	uuid_le ish_heci_guid = UUID_LE(0x33AECD58, 0xB679, 0x4E54, 0x9B, 0xD9, 0xA0, 0x4D, 0x34, 0xF0, 0xC2, 0x26);

extern wait_queue_head_t	heci_hid_wait;

/*flush notification*/
extern void (*flush_cb)(void);

struct hostif_msg_hdr {
	uint8_t	command;	/* Bit 7: is_response */
#define	CMD_MASK	0x7F
#define	IS_RESPONSE	0x80
	uint8_t	device_id;
	uint8_t	status;
	uint8_t	flags;
	uint16_t	size;
} __attribute__((packed));

struct hostif_msg {
	struct hostif_msg_hdr	hdr;
} __attribute__((packed));

struct hostif_msg_to_sensor {
	struct hostif_msg_hdr	hdr;
	uint8_t	report_id;
} __attribute__((packed));

struct device_info {
	uint32_t	dev_id;
	uint8_t		dev_class;
	uint16_t	pid;
	uint16_t	vid;
} __attribute__((packed));

#if 0
/* Needed? */
struct heci_client {
	uint32_t	max_msg_len;
	uint8_t		proto_ver;
} __attribute__((packed));
#endif

struct heci_version {
	uint8_t	major;
	uint8_t	minor;
	uint8_t	hotfix;
	uint16_t	build;
} __attribute__((packed));

/*
 * struct for heci aggregated input data
 */
struct report_list {
	uint16_t total_size;
	uint8_t  num_of_reports;
	uint8_t  flags;
	struct {
		uint16_t  size_of_report;
		uint8_t report[1];
	} __attribute__((packed)) reports[1];
} __attribute__((packed));

/* HOSTIF commands */
#define	HOSTIF_HID_COMMAND_BASE		0
#define	HOSTIF_GET_HID_DESCRIPTOR	0
#define	HOSTIF_GET_REPORT_DESCRIPTOR	1
#define HOSTIF_GET_FEATURE_REPORT	2
#define	HOSTIF_SET_FEATURE_REPORT	3
#define	HOSTIF_GET_INPUT_REPORT		4
#define	HOSTIF_PUBLISH_INPUT_REPORT	5
/*#define	HOSTIF_GET_OUTPUT_REPORT	6*/
/*#define	HOSTIF_SET_OUTPUT_REPORT	7*/
#define	HOSTIF_PUBLISH_INPUT_REPORT_LIST	6
#define	HOSTIF_DM_COMMAND_BASE		32
#define	HOSTIF_DM_ENUM_DEVICES		33
#define	HOSTIF_DM_ADD_DEVICE		34

/* Meaning, too large data source = "over 9000?" :-) */
#define	MAX_DATA_BUF	9000

#define	MAX_HID_DEVICES	32

#include "utils.h"

/*flush notification*/
void register_flush_cb(void (*flush_cb_func)(void));

#endif	/* HECI_HID__H */