xref: /haiku/src/add-ons/input_server/devices/mouse/MouseInputDevice.cpp (revision 6af8fc09735b8cd7efc713db08f3fee0ded2aa6f)

/*****************************************************************************/
// Mouse input server device addon
// Written by Stefano Ceccherini
//
// MouseInputDevice.cpp
//
// Copyright (c) 2004-2005 Haiku Project
//
// 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 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.
/*****************************************************************************/

// TODO: Use strlcpy instead of strcpy

#include "MouseInputDevice.h"
#include "kb_mouse_settings.h"
#include "kb_mouse_driver.h"

#include <stdlib.h>
#include <unistd.h>

#include <Debug.h>
#include <Directory.h>
#include <Entry.h>
#include <NodeMonitor.h>
#include <Path.h>
#include <String.h>

#if DEBUG
        inline void LOG(const char *fmt, ...) { char buf[1024]; va_list ap; va_start(ap, fmt); vsprintf(buf, fmt, ap); va_end(ap); \
                fputs(buf, MouseInputDevice::sLogFile); fflush(MouseInputDevice::sLogFile); }
        #define LOG_ERR(text...) LOG(text)
FILE *MouseInputDevice::sLogFile = NULL;
#else
        #define LOG(text...)
        #define LOG_ERR(text...) fprintf(stderr, text)
#endif

#define CALLED() LOG("%s\n", __PRETTY_FUNCTION__)

static MouseInputDevice *sSingletonMouseDevice = NULL;

const static uint32 kMouseThreadPriority = B_FIRST_REAL_TIME_PRIORITY + 4;
const static char *kMouseDevicesDirectory = "/dev/input/mouse";

// "/dev/" is automatically prepended by StartMonitoringDevice()
const static char *kMouseDevicesDirectoryUSB = "input/mouse/usb";

struct mouse_device {
	mouse_device(const char *path);
	~mouse_device();

	input_device_ref device_ref;
	char path[B_PATH_NAME_LENGTH];
	int fd;
	thread_id device_watcher;
	mouse_settings settings;
	bool active;
};


// forward declarations
static char *get_short_name(const char *longName);


extern "C"
BInputServerDevice *
instantiate_input_device()
{
	return new MouseInputDevice();
}


MouseInputDevice::MouseInputDevice()
{
	ASSERT(sSingletonMouseDevice == NULL);
	sSingletonMouseDevice = this;

#if DEBUG
	sLogFile = fopen("/var/log/mouse_device_log.log", "a");
#endif
	CALLED();

	StartMonitoringDevice(kMouseDevicesDirectoryUSB);
}


MouseInputDevice::~MouseInputDevice()
{
	CALLED();
	StopMonitoringDevice(kMouseDevicesDirectoryUSB);

	for (int32 i = 0; i < fDevices.CountItems(); i++)
		delete (mouse_device *)fDevices.ItemAt(i);

#if DEBUG
	fclose(sLogFile);
#endif
}


status_t
MouseInputDevice::InitFromSettings(void *cookie, uint32 opcode)
{
	CALLED();
	mouse_device *device = (mouse_device *)cookie;

	// retrieve current values

	if (get_mouse_map(&device->settings.map) != B_OK)
		LOG_ERR("error when get_mouse_map\n");
	else
		ioctl(device->fd, MS_SET_MAP, &device->settings.map);

	if (get_click_speed(&device->settings.click_speed) != B_OK)
		LOG_ERR("error when get_click_speed\n");
	else
		ioctl(device->fd, MS_SET_CLICKSPEED, &device->settings.click_speed);

	if (get_mouse_speed(&device->settings.accel.speed) != B_OK)
		LOG_ERR("error when get_mouse_speed\n");
	else {
		if (get_mouse_acceleration(&device->settings.accel.accel_factor) != B_OK)
			LOG_ERR("error when get_mouse_acceleration\n");
		else {
			mouse_accel accel;
			ioctl(device->fd, MS_GET_ACCEL, &accel);
			accel.speed = device->settings.accel.speed;
			accel.accel_factor = device->settings.accel.accel_factor;
			ioctl(device->fd, MS_SET_ACCEL, &device->settings.accel);
		}
	}

	if (get_mouse_type(&device->settings.type) != B_OK)
		LOG_ERR("error when get_mouse_type\n");
	else
		ioctl(device->fd, MS_SET_TYPE, &device->settings.type);

	return B_OK;

}


status_t
MouseInputDevice::InitCheck()
{
	CALLED();
	RecursiveScan(kMouseDevicesDirectory);

	return B_OK;
}


status_t
MouseInputDevice::Start(const char *name, void *cookie)
{
	mouse_device *device = (mouse_device *)cookie;

	LOG("%s(%s)\n", __PRETTY_FUNCTION__, name);

	device->fd = open(device->path, O_RDWR);
	if (device->fd < 0)
		return device->fd;

	status_t status = InitFromSettings(device);
	if (status < B_OK) {
		LOG_ERR("%s: can't initialize from settings: %s\n",
			name, strerror(status));
		return status;
	}

	char threadName[B_OS_NAME_LENGTH];
	snprintf(threadName, B_OS_NAME_LENGTH, "%s watcher", name);

	device->active = true;
	device->device_watcher = spawn_thread(DeviceWatcher, threadName,
		kMouseThreadPriority, device);

	if (device->device_watcher < B_OK) {
		LOG_ERR("%s: can't spawn watching thread: %s\n",
			name, strerror(device->device_watcher));
		return device->device_watcher;
	}

	status = resume_thread(device->device_watcher);
	if (status < B_OK) {
		LOG_ERR("%s: can't resume watching thread: %s\n",
			name, strerror(status));
		return status;
	}

	return B_OK;
}


status_t
MouseInputDevice::Stop(const char *name, void *cookie)
{
	mouse_device *device = (mouse_device *)cookie;

	LOG("%s(%s)\n", __PRETTY_FUNCTION__, name);

	close(device->fd);

	device->active = false;
	if (device->device_watcher >= 0) {
		// TODO: This is done to unblock the thread,
		// which is waiting on a semaphore.
		suspend_thread(device->device_watcher);
		resume_thread(device->device_watcher);
		status_t dummy;
		wait_for_thread(device->device_watcher, &dummy);
	}

	return B_OK;
}


status_t
MouseInputDevice::Control(const char *name, void *cookie,
						  uint32 command, BMessage *message)
{
	LOG("%s(%s, code: %lu)\n", __PRETTY_FUNCTION__, name, command);
	status_t status = B_BAD_VALUE;

	if (command == B_NODE_MONITOR)
		status = HandleMonitor(message);
	else if (command >= B_MOUSE_TYPE_CHANGED
		&& command <= B_MOUSE_ACCELERATION_CHANGED) {
		status = InitFromSettings(cookie, command);
	}
	return status;
}


// TODO: Test this. USB doesn't work on my machine
status_t
MouseInputDevice::HandleMonitor(BMessage *message)
{
	CALLED();
	int32 opcode = 0;
	status_t status;
	if ((status = message->FindInt32("opcode", &opcode)) < B_OK)
	        return status;

	if ((opcode != B_ENTRY_CREATED)
	        && (opcode != B_ENTRY_REMOVED))
	        return B_OK;

	BEntry entry;
	BPath path;
	dev_t device;
	ino_t directory;
	const char *name = NULL;

	message->FindInt32("device", &device);
	message->FindInt64("directory", &directory);
	message->FindString("name", &name);

	entry_ref ref(device, directory, name);

	if ((status = entry.SetTo(&ref)) != B_OK)
	        return status;
	if ((status = entry.GetPath(&path)) != B_OK)
	        return status;
	if ((status = path.InitCheck()) != B_OK)
	        return status;

	if (opcode == B_ENTRY_CREATED)
		status = AddDevice(path.Path());
	else
		status = RemoveDevice(path.Path());

	return status;
}


status_t
MouseInputDevice::AddDevice(const char *path)
{
	CALLED();

	mouse_device *device = new mouse_device(path);
	if (!device) {
		LOG("No memory\n");
		return B_NO_MEMORY;
	}

	input_device_ref *devices[2];
	devices[0] = &device->device_ref;
	devices[1] = NULL;

	fDevices.AddItem(device);

	return RegisterDevices(devices);
}


status_t
MouseInputDevice::RemoveDevice(const char *path)
{
	CALLED();
	int32 i = 0;
	mouse_device *device = NULL;
	while ((device = (mouse_device *)fDevices.ItemAt(i)) != NULL) {
		if (!strcmp(device->path, path)) {
			fDevices.RemoveItem(device);
			delete device;
			return B_OK;
		}
	}

	return B_ENTRY_NOT_FOUND;
}


int32
MouseInputDevice::DeviceWatcher(void *arg)
{
	mouse_device *dev = (mouse_device *)arg;

	mouse_movement movements;
	uint32 buttons_state = 0;
	BMessage *message;
	while (dev->active) {
		memset(&movements, 0, sizeof(movements));
		if (ioctl(dev->fd, MS_READ, &movements) < B_OK)
			continue;

		uint32 buttons = buttons_state ^ movements.buttons;

		LOG("%s: buttons: 0x%lx, x: %ld, y: %ld, clicks:%ld, wheel_x:%ld, wheel_y:%ld\n", dev->device_ref.name, movements.buttons,
			movements.xdelta, movements.ydelta, movements.clicks, movements.wheel_xdelta, movements.wheel_ydelta);

		// TODO: add acceleration computing
		int32 xdelta = movements.xdelta * dev->settings.accel.speed >> 15;
		int32 ydelta = movements.ydelta * dev->settings.accel.speed >> 15;

		LOG("%s: x: %ld, y: %ld, \n", dev->device_ref.name, xdelta, ydelta);

		// TODO: Here we send B_MOUSE_UP/DOWN before B_MOUSE_MOVED.
		// This could be the cause of the bug in RootLayer.cpp:
		// "mouse position changed in B_MOUSE_DOWN from last B_MOUSE_MOVED".
		// Might be wiser to switch the order.
		if (buttons != 0) {
			message = new BMessage(B_MOUSE_UP);
			if ((buttons & movements.buttons) > 0) {
				message->what = B_MOUSE_DOWN;
				message->AddInt32("clicks", movements.clicks);
				LOG("B_MOUSE_DOWN\n");
			} else {
				LOG("B_MOUSE_UP\n");
			}

			message->AddInt64("when", movements.timestamp);
			message->AddInt32("buttons", movements.buttons);
			message->AddInt32("x", xdelta);
			message->AddInt32("y", ydelta);
			sSingletonMouseDevice->EnqueueMessage(message);
			buttons_state = movements.buttons;
		}

		if (movements.xdelta != 0 || movements.ydelta != 0) {
			message = new BMessage(B_MOUSE_MOVED);
			if (message) {
				message->AddInt64("when", movements.timestamp);
				message->AddInt32("buttons", movements.buttons);
				message->AddInt32("x", xdelta);
				message->AddInt32("y", ydelta);

				sSingletonMouseDevice->EnqueueMessage(message);
			}
		}

		if ((movements.wheel_ydelta != 0) || (movements.wheel_xdelta != 0)) {
			message = new BMessage(B_MOUSE_WHEEL_CHANGED);
			if (message) {
				message->AddInt64("when", movements.timestamp);
				message->AddFloat("be:wheel_delta_x", movements.wheel_xdelta);
				message->AddFloat("be:wheel_delta_y", movements.wheel_ydelta);

				sSingletonMouseDevice->EnqueueMessage(message);
			}
		}

	}

	return 0;
}


// mouse_device
mouse_device::mouse_device(const char *driver_path)
{
	fd = -1;
	device_watcher = -1;
	active = false;
	strcpy(path, driver_path);
	device_ref.name = get_short_name(path);
	device_ref.type = B_POINTING_DEVICE;
	device_ref.cookie = this;
};


mouse_device::~mouse_device()
{
	free(device_ref.name);
}


void
MouseInputDevice::RecursiveScan(const char *directory)
{
	CALLED();

	bool found_ps2 = false;
	BEntry entry;
	BDirectory dir(directory);
	while (dir.GetNextEntry(&entry) == B_OK) {
		BPath path;
		entry.GetPath(&path);

		char name[B_FILE_NAME_LENGTH];
		entry.GetName(name);
		if (strcmp(name, "ps2") == 0)
			found_ps2 = true;
		if (strcmp(name,"serial") == 0 && found_ps2)
			continue;

		if (entry.IsDirectory())
			RecursiveScan(path.Path());
		else
			AddDevice(path.Path());
	}
}


static char *
get_short_name(const char *longName)
{
	BString string(longName);
	BString name;

	int32 slash = string.FindLast("/");
	string.CopyInto(name, slash + 1, string.Length() - slash);
	int32 index = atoi(name.String()) + 1;

	int32 previousSlash = string.FindLast("/", slash);
	string.CopyInto(name, previousSlash + 1, slash - previousSlash - 1);

	if (name == "ps2")
		name = "PS/2";
	else
		name.Capitalize();

	name << " Mouse " << index;

	return strdup(name.String());
}