xref: /aosp_15_r20/external/rmi4utils/rmidevice/hiddevice.h (revision a248dafd7653b99fc45f9d29e5f139b04f2f28bc)

/*
 * Copyright (C) 2014 Andrew Duggan
 * Copyright (C) 2014 Synaptics Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _HIDDEVICE_H_
#define _HIDDEVICE_H_

#include <linux/hidraw.h>
#include <string>
#include <fstream>
#include <stdint.h>
#include "rmidevice.h"

enum rmi_hid_mode_type {
	HID_RMI4_MODE_MOUSE                     = 0,
	HID_RMI4_MODE_ATTN_REPORTS              = 1,
	HID_RMI4_MODE_NO_PACKED_ATTN_REPORTS    = 2,
};

class HIDDevice : public RMIDevice
{
public:
	HIDDevice() : RMIDevice(), m_inputReport(NULL), m_outputReport(NULL), m_attnData(NULL),
		      m_readData(NULL),
		      m_inputReportSize(0),
		      m_outputReportSize(0),
		      m_featureReportSize(0),
		      m_deviceOpen(false),
		      m_mode(HID_RMI4_MODE_ATTN_REPORTS),
		      m_initialMode(HID_RMI4_MODE_MOUSE),
		      m_transportDeviceName(""),
		      m_driverPath(""),
		      hasVendorDefineLIDMode(false)
	{}
	virtual int Open(const char * filename);
	virtual int Read(unsigned short addr, unsigned char *buf,
				unsigned short len);
	virtual int Write(unsigned short addr, const unsigned char *buf,
				 unsigned short len);
	virtual int SetMode(int mode);
	virtual int ToggleInterruptMask(bool enable);
	virtual int WaitForAttention(struct timeval * timeout = NULL,
					unsigned int source_mask = RMI_INTERUPT_SOURCES_ALL_MASK);
	virtual int GetAttentionReport(struct timeval * timeout, unsigned int source_mask,
					unsigned char *buf, unsigned int *len);
	virtual void Close();
	virtual void RebindDriver();
	~HIDDevice() { Close(); }

	virtual void PrintDeviceInfo();

	virtual bool FindDevice(enum RMIDeviceType type = RMI_DEVICE_TYPE_ANY);
	virtual bool CheckABSEvent();

private:
	int m_fd;

	struct hidraw_report_descriptor m_rptDesc;
	struct hidraw_devinfo m_info;

	unsigned char *m_inputReport;
	unsigned char *m_outputReport;

	unsigned char *m_attnData;
	unsigned char *m_readData;
	int m_dataBytesRead;

	size_t m_inputReportSize;
	size_t m_outputReportSize;
	size_t m_featureReportSize;

	bool m_deviceOpen;

	rmi_hid_mode_type m_mode;
	rmi_hid_mode_type m_initialMode;

	std::string m_transportDeviceName;
	std::string m_driverPath;

	bool hasVendorDefineLIDMode;

	int GetReport(int *reportId, struct timeval * timeout = NULL);
	void PrintReport(const unsigned char *report);
	void ParseReportDescriptor();

	bool WaitForHidRawDevice(int notifyFd, std::string & hidraw);

	// static HID utility functions
	static bool LookupHidDeviceName(uint32_t bus, int16_t vendorId, int16_t productId, std::string &deviceName);
	static bool LookupHidDriverName(std::string &deviceName, std::string &driverName);
	static bool FindTransportDevice(uint32_t bus, std::string & hidDeviceName,
					std::string & transportDeviceName, std::string & driverPath);
 };

#endif /* _HIDDEVICE_H_ */