device.h File Reference

#include "includes.h"
#include "keymap.h"

Include dependency graph for device.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	DEV_MAX   9
#define	IS_CONNECTED(kb)   ((kb) && (kb)->handle && (kb)->uinput_kb && (kb)->uinput_mouse)
#define	dmutex(kb)   (devmutex + INDEX_OF(kb, keyboard))
#define	imutex(kb)   (inputmutex + INDEX_OF(kb, keyboard))
#define	mmutex(kb)   (macromutex + INDEX_OF(kb, keyboard))
#define	mmutex2(kb)   (macromutex2 + INDEX_OF(kb, keyboard))
#define	mvar(kb)   (macrovar + INDEX_OF(kb, keyboard))
#define	setactive(kb, makeactive)   ((makeactive) ? (kb)->vtable->active((kb), 0, 0, 0, 0) : (kb)->vtable->idle((kb), 0, 0, 0, 0))
	setactive() calls via the corresponding kb->vtable either the active() or the idle() function. active() is called if the parameter makeactive is true, idle if it is false. What function is called effectively is device dependent. Have a look at device_vtable.c for more information. More...
#define	IN_HID   0x80
#define	IN_CORSAIR   0x40
#define	ACT_LIGHT   1
#define	ACT_NEXT   3
#define	ACT_NEXT_NOWRAP   5
#define	ACT_LOCK   8
#define	ACT_MR_RING   9
#define	ACT_M1   10
#define	ACT_M2   11
#define	ACT_M3   12

Functions
int	start_dev (usbdevice *kb, int makeactive)
int	start_kb_nrgb (usbdevice *kb, int makeactive)
int	setactive_kb (usbdevice *kb, int active)
int	setactive_mouse (usbdevice *kb, int active)
int	cmd_active_kb (usbdevice *kb, usbmode *dummy1, int dummy2, int dummy3, const char *dummy4)
int	cmd_active_mouse (usbdevice *kb, usbmode *dummy1, int dummy2, int dummy3, const char *dummy4)
int	cmd_idle_kb (usbdevice *kb, usbmode *dummy1, int dummy2, int dummy3, const char *dummy4)
int	cmd_idle_mouse (usbdevice *kb, usbmode *dummy1, int dummy2, int dummy3, const char *dummy4)
int	cmd_pollrate (usbdevice *kb, usbmode *dummy1, int dummy2, int rate, const char *dummy3)
void	setmodeindex_nrgb (usbdevice *kb, int index)

Variables
usbdevice	keyboard [9]
	remember all usb devices. Needed for closeusb(). More...
pthread_mutex_t	devmutex [9]
	Mutex for handling the usbdevice structure. More...
pthread_mutex_t	inputmutex [9]
	Mutex for dealing with usb input frames. More...
pthread_mutex_t	macromutex [9]
	Protecting macros against lightning: Both use usb_send. More...
pthread_mutex_t	macromutex2 [9]
	Protecting the single link list of threads and the macrovar. More...
pthread_cond_t	macrovar [9]
	This variable is used to stop and wakeup all macro threads which have to wait. More...

Macro Definition Documentation

#define ACT_LIGHT   1

Definition at line 68 of file device.h.

Referenced by setactive_kb().

#define ACT_LOCK   8

Definition at line 71 of file device.h.

Referenced by setactive_kb().

#define ACT_M1   10

Definition at line 73 of file device.h.

Referenced by setactive_kb().

#define ACT_M2   11

Definition at line 74 of file device.h.

Referenced by setactive_kb().

#define ACT_M3   12

Definition at line 75 of file device.h.

Referenced by setactive_kb().

#define ACT_MR_RING   9

Definition at line 72 of file device.h.

Referenced by setactive_kb().

#define ACT_NEXT   3

Definition at line 69 of file device.h.

#define ACT_NEXT_NOWRAP   5

Definition at line 70 of file device.h.

#define DEV_MAX   9

Definition at line 8 of file device.h.

Referenced by _start_dev(), _updateconnected(), quitWithLock(), usb_rm_device(), and usbadd().

#define dmutex

(

kb

)

(devmutex + INDEX_OF(kb, keyboard))

Definition at line 18 of file device.h.

Referenced by _ledthread(), _setupusb(), closeusb(), devmain(), and usbadd().

#define imutex

(

kb

)

(inputmutex + INDEX_OF(kb, keyboard))

Definition at line 22 of file device.h.

Referenced by _setupusb(), closeusb(), cmd_bind(), cmd_erase(), cmd_eraseprofile(), cmd_get(), cmd_macro(), cmd_notify(), cmd_rebind(), cmd_unbind(), os_inputmain(), setactive_kb(), setactive_mouse(), and setupusb().

#define IN_CORSAIR   0x40

Definition at line 65 of file device.h.

Referenced by setactive_kb(), and setactive_mouse().

#define IN_HID   0x80

Definition at line 64 of file device.h.

Referenced by setactive_kb(), and setactive_mouse().

#define IS_CONNECTED

(

kb

)

((kb) && (kb)->handle && (kb)->uinput_kb && (kb)->uinput_mouse)

Definition at line 12 of file device.h.

Referenced by _updateconnected(), devmain(), quitWithLock(), and usbadd().

#define mmutex

(

kb

)

(macromutex + INDEX_OF(kb, keyboard))

Definition at line 26 of file device.h.

Referenced by _usbrecv(), _usbsend(), and play_macro().

#define mmutex2

(

kb

)

(macromutex2 + INDEX_OF(kb, keyboard))

Definition at line 28 of file device.h.

Referenced by play_macro().

#define mvar

(

kb

)

(macrovar + INDEX_OF(kb, keyboard))

Definition at line 30 of file device.h.

Referenced by play_macro().

#define setactive	(		kb,
			makeactive
	)		((makeactive) ? (kb)->vtable->active((kb), 0, 0, 0, 0) : (kb)->vtable->idle((kb), 0, 0, 0, 0))

Definition at line 44 of file device.h.

Referenced by _start_dev(), and revertusb().

Function Documentation

int cmd_active_kb	(	usbdevice *	kb,
		usbmode *	dummy1,
		int	dummy2,
		int	dummy3,
		const char *	dummy4
	)

Definition at line 114 of file device_keyboard.c.

References setactive_kb().

                                                                                             {
    (void)dummy1;
    (void)dummy2;
    (void)dummy3;
    (void)dummy4;

    return setactive_kb(kb, 1);
}

Here is the call graph for this function:

int cmd_active_mouse	(	usbdevice *	kb,
		usbmode *	dummy1,
		int	dummy2,
		int	dummy3,
		const char *	dummy4
	)

Definition at line 44 of file device_mouse.c.

References setactive_mouse().

                                                                                                {
    (void)dummy1;
    (void)dummy2;
    (void)dummy3;
    (void)dummy4;

    return setactive_mouse(kb, 1);
}

Here is the call graph for this function:

int cmd_idle_kb	(	usbdevice *	kb,
		usbmode *	dummy1,
		int	dummy2,
		int	dummy3,
		const char *	dummy4
	)

Definition at line 123 of file device_keyboard.c.

References setactive_kb().

                                                                                           {
    (void)dummy1;
    (void)dummy2;
    (void)dummy3;
    (void)dummy4;

    return setactive_kb(kb, 0);
}

Here is the call graph for this function:

int cmd_idle_mouse	(	usbdevice *	kb,
		usbmode *	dummy1,
		int	dummy2,
		int	dummy3,
		const char *	dummy4
	)

Definition at line 53 of file device_mouse.c.

References setactive_mouse().

                                                                                              {
    (void)dummy1;
    (void)dummy2;
    (void)dummy3;
    (void)dummy4;

    return setactive_mouse(kb, 0);
}

Here is the call graph for this function:

int cmd_pollrate	(	usbdevice *	kb,
		usbmode *	dummy1,
		int	dummy2,
		int	rate,
		const char *	dummy3
	)

Definition at line 62 of file device_mouse.c.

References MSG_SIZE, usbdevice::pollrate, and usbsend.

                                                                                          {
    (void)dummy1;
    (void)dummy2;
    (void)dummy3;

    uchar msg[MSG_SIZE] = {
        0x07, 0x0a, 0, 0, (uchar)rate
    };
    if(!usbsend(kb, msg, 1))
        return -1;
    // Device should disconnect+reconnect, but update the poll rate field in case it doesn't
    kb->pollrate = rate;
    return 0;
}

int setactive_kb	(	usbdevice *	kb,
		int	active
	)

Definition at line 20 of file device_keyboard.c.

References ACT_LIGHT, ACT_LOCK, ACT_M1, ACT_M2, ACT_M3, ACT_MR_RING, usbdevice::active, DELAY_MEDIUM, lighting::forceupdate, imutex, IN_CORSAIR, IN_HID, usbdevice::input, inputupdate(), keymap, usbinput::keys, usbprofile::lastlight, MSG_SIZE, N_KEYS_HW, NEEDS_FW_UPDATE, usbdevice::profile, usbsend, and usbdevice::vtable.

Referenced by cmd_active_kb(), and cmd_idle_kb().

                                           {
    if(NEEDS_FW_UPDATE(kb))
        return 0;

    pthread_mutex_lock(imutex(kb));
    kb->active = !!active;
    kb->profile->lastlight.forceupdate = 1;
    // Clear input
    memset(&kb->input.keys, 0, sizeof(kb->input.keys));
    inputupdate(kb);
    pthread_mutex_unlock(imutex(kb));

    uchar msg[3][MSG_SIZE] = {
        { 0x07, 0x04, 0 },                  // Disables or enables HW control for top row
        { 0x07, 0x40, 0 },                  // Selects key input
        { 0x07, 0x05, 2, 0, 0x03, 0x00 }    // Commits key input selection
    };
    if(active){
        // Put the M-keys (K95) as well as the Brightness/Lock keys into software-controlled mode.
        msg[0][2] = 2;
        if(!usbsend(kb, msg[0], 1))
            return -1;
        DELAY_MEDIUM(kb);
        // Set input mode on the keys. They must be grouped into packets of 60 bytes (+ 4 bytes header)
        // Keys are referenced in byte pairs, with the first byte representing the key and the second byte representing the mode.
        for(int key = 0; key < N_KEYS_HW; ){
            int pair;
            for(pair = 0; pair < 30 && key < N_KEYS_HW; pair++, key++){
                // Select both standard and Corsair input. The standard input will be ignored except in BIOS mode.
                uchar action = IN_HID | IN_CORSAIR;
                // Additionally, make MR activate the MR ring (this is disabled for now, may be back later)
                //if(keymap[key].name && !strcmp(keymap[key].name, "mr"))
                //    action |= ACT_MR_RING;
                msg[1][4 + pair * 2] = key;
                msg[1][5 + pair * 2] = action;
            }
            // Byte 2 = pair count (usually 30, less on final message)
            msg[1][2] = pair;
            if(!usbsend(kb, msg[1], 1))
                return -1;
        }
        // Commit new input settings
        if(!usbsend(kb, msg[2], 1))
            return -1;
        DELAY_MEDIUM(kb);
    } else {
        // Set the M-keys back into hardware mode, restore hardware RGB profile. It has to be sent twice for some reason.
        msg[0][2] = 1;
        if(!usbsend(kb, msg[0], 1))
            return -1;
        DELAY_MEDIUM(kb);
        if(!usbsend(kb, msg[0], 1))
            return -1;
        DELAY_MEDIUM(kb);
#ifdef OS_LINUX
        // On OSX the default key mappings are fine. On Linux, the G keys will freeze the keyboard. Set the keyboard entirely to HID input.
        for(int key = 0; key < N_KEYS_HW; ){
            int pair;
            for(pair = 0; pair < 30 && key < N_KEYS_HW; pair++, key++){
                uchar action = IN_HID;
                // Enable hardware actions
                if(keymap[key].name){
                    if(!strcmp(keymap[key].name, "mr"))
                        action = ACT_MR_RING;
                    else if(!strcmp(keymap[key].name, "m1"))
                        action = ACT_M1;
                    else if(!strcmp(keymap[key].name, "m2"))
                        action = ACT_M2;
                    else if(!strcmp(keymap[key].name, "m3"))
                        action = ACT_M3;
                    else if(!strcmp(keymap[key].name, "light"))
                        action = ACT_LIGHT;
                    else if(!strcmp(keymap[key].name, "lock"))
                        action = ACT_LOCK;
                }
                msg[1][4 + pair * 2] = key;
                msg[1][5 + pair * 2] = action;
            }
            // Byte 2 = pair count (usually 30, less on final message)
            msg[1][2] = pair;
            if(!usbsend(kb, msg[1], 1))
                return -1;
        }
        // Commit new input settings
        if(!usbsend(kb, msg[2], 1))
            return -1;
        DELAY_MEDIUM(kb);
#endif
    }
    // Update indicator LEDs if the profile contains settings for them
    kb->vtable->updateindicators(kb, 0);
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int setactive_mouse	(	usbdevice *	kb,
		int	active
	)

Definition at line 9 of file device_mouse.c.

References usbdevice::active, lighting::forceupdate, imutex, IN_CORSAIR, IN_HID, usbdevice::input, inputupdate(), usbinput::keys, usbprofile::lastlight, MSG_SIZE, NEEDS_FW_UPDATE, usbdevice::profile, and usbsend.

Referenced by cmd_active_mouse(), and cmd_idle_mouse().

                                              {
    if(NEEDS_FW_UPDATE(kb))
        return 0;
    const int keycount = 20;
    uchar msg[2][MSG_SIZE] = {
        { 0x07, 0x04, 0 },                  // Disables or enables HW control for DPI and Sniper button
        { 0x07, 0x40, keycount, 0 },        // Select button input (simlilar to the packet sent to keyboards, but lacks a commit packet)
    };
    if(active)
        // Put the mouse into SW mode
        msg[0][2] = 2;
    else
        // Restore HW mode
        msg[0][2] = 1;
    pthread_mutex_lock(imutex(kb));
    kb->active = !!active;
    kb->profile->lastlight.forceupdate = 1;
    // Clear input
    memset(&kb->input.keys, 0, sizeof(kb->input.keys));
    inputupdate(kb);
    pthread_mutex_unlock(imutex(kb));
    if(!usbsend(kb, msg[0], 1))
        return -1;
    if(active){
        // Set up key input
        if(!usbsend(kb, msg[1], 1))
            return -1;
        for(int i = 0; i < keycount; i++){
            msg[1][i * 2 + 4] = i + 1;
            msg[1][i * 2 + 5] = (i < 6 ? IN_HID : IN_CORSAIR);
        }
    }
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void setmodeindex_nrgb	(	usbdevice *	kb,
		int	index
	)

Definition at line 132 of file device_keyboard.c.

References NK95_M1, NK95_M2, NK95_M3, and nk95cmd.

                                                {
    switch(index % 3){
    case 0:
        nk95cmd(kb, NK95_M1);
        break;
    case 1:
        nk95cmd(kb, NK95_M2);
        break;
    case 2:
        nk95cmd(kb, NK95_M3);
        break;
    }
}

int start_dev	(	usbdevice *	kb,
		int	makeactive
	)

Definition at line 89 of file device.c.

References _start_dev(), USB_DELAY_DEFAULT, and usbdevice::usbdelay.

                                            {
    // Force USB interval to 10ms during initial setup phase; return to nominal 5ms after setup completes.
    kb->usbdelay = 10;
    int res = _start_dev(kb, makeactive);
    kb->usbdelay = USB_DELAY_DEFAULT;
    return res;
}

Here is the call graph for this function:

int start_kb_nrgb	(	usbdevice *	kb,
		int	makeactive
	)

Definition at line 9 of file device_keyboard.c.

References usbdevice::active, NK95_HWOFF, nk95cmd, and usbdevice::pollrate.

                                                {
    (void)makeactive;

    // Put the non-RGB K95 into software mode. Nothing else needs to be done hardware wise
    nk95cmd(kb, NK95_HWOFF);
    // Fill out RGB features for consistency, even though the keyboard doesn't have them
    kb->active = 1;
    kb->pollrate = -1;
    return 0;
}

Variable Documentation

pthread_mutex_t devmutex[9]

Definition at line 12 of file device.c.

Referenced by _updateconnected(), quitWithLock(), and usb_rm_device().

pthread_mutex_t inputmutex[9]

Definition at line 13 of file device.c.

usbdevice keyboard[9]

Definition at line 10 of file device.c.

Referenced by _mkdevpath(), _mknotifynode(), _rmnotifynode(), _setupusb(), _updateconnected(), closeusb(), main(), mkfwnode(), os_closeusb(), os_inputmain(), os_inputopen(), os_setupusb(), quitWithLock(), rmdevpath(), usb_rm_device(), and usbadd().

pthread_mutex_t macromutex[9]

Definition at line 14 of file device.c.

pthread_mutex_t macromutex2[9]

Definition at line 15 of file device.c.

pthread_cond_t macrovar[9]

Definition at line 16 of file device.c.