device.c File Reference

#include "command.h"
#include "device.h"
#include "firmware.h"
#include "profile.h"
#include "usb.h"

Include dependency graph for device.c:

Go to the source code of this file.

Functions
int	_start_dev (usbdevice *kb, int makeactive)
int	start_dev (usbdevice *kb, int makeactive)

Variables
int	hwload_mode = 1
	hwload_mode = 1 means read hardware once. should be enough More...
usbdevice	keyboard [9]
	remember all usb devices. Needed for closeusb(). More...
pthread_mutex_t	devlistmutex = PTHREAD_MUTEX_INITIALIZER
pthread_mutex_t	devmutex [9] = { [0 ... 9 -1] = PTHREAD_MUTEX_INITIALIZER }
	Mutex for handling the usbdevice structure. More...
pthread_mutex_t	inputmutex [9] = { [0 ... 9 -1] = PTHREAD_MUTEX_INITIALIZER }
	Mutex for dealing with usb input frames. More...
pthread_mutex_t	macromutex [9] = { [0 ... 9 -1] = PTHREAD_MUTEX_INITIALIZER }
	Protecting macros against lightning: Both use usb_send. More...
pthread_mutex_t	macromutex2 [9] = { [0 ... 9 -1] = PTHREAD_MUTEX_INITIALIZER }
	Protecting the single link list of threads and the macrovar. More...
pthread_cond_t	macrovar [9] = { [0 ... 9 -1] = PTHREAD_COND_INITIALIZER }
	This variable is used to stop and wakeup all macro threads which have to wait. More...

Function Documentation

int _start_dev	(	usbdevice *	kb,
		int	makeactive
	)

_start_dev get fw-info and pollrate; if available, install new firmware; get all hardware profiles.

Parameters

kb	the normal kb pointer to the usbdevice. Is also valid for mice.
makeactive	if set to 1, activate the device via setactive()

Returns

0 if success, other else

• This hacker code is tricky in mutliple aspects. What it means is:
  if hwload_mode == 0: just set pollrate to 0 and clear features in the bottom lines of the if-block.
  if hwload_mode == 1: if the device has FEAT_HWLOAD active, call getfwversion(). If it returns true, there was an error while detecting fw-version. Put error message, reset FEAT_HWLOAD and finalize as above.
  if hwload_mode == 2: if the device has FEAT_HWLOAD active, call getfwversion(). If it returns true, there was an error while detecting fw-version. Put error message and return directly from function with error.
  Why do not you just write it down?
• Now check if device needs a firmware update. If so, set it up and leave the function without error.
• Device needs a firmware update. Finish setting up but don't do anything.
• Load profile from device if the hw-pointer is not set yet and hw-loading is possible and allowed.
  return error if mode == 2 (load always) and loading got an error. Else reset HWLOAD feature, because hwload must be 1.
  
  That is real Horror code.

Definition at line 25 of file device.c.

References usbdevice::active, ckb_info, ckb_warn, DEV_MAX, FEAT_ADJRATE, FEAT_FWUPDATE, FEAT_FWVERSION, FEAT_HWLOAD, FEAT_POLLRATE, FEAT_RGB, usbdevice::features, usbdevice::fwversion, getfwversion(), HAS_FEATURES, usbdevice::hw, hwload_mode, hwloadprofile, NEEDS_FW_UPDATE, usbdevice::pollrate, and setactive.

Referenced by start_dev().

                                             {
    // Get the firmware version from the device
    if(kb->pollrate == 0){
        if(!hwload_mode || (HAS_FEATURES(kb, FEAT_HWLOAD) && getfwversion(kb))){
            if(hwload_mode == 2)
                // hwload=always. Report setup failure.
                return -1;
            else if(hwload_mode){
                // hwload=once. Log failure, prevent trying again, and continue.
                ckb_warn("Unable to load firmware version/poll rate\n");
                kb->features &= ~FEAT_HWLOAD;
            }
            kb->pollrate = 0;
            kb->features &= ~(FEAT_POLLRATE | FEAT_ADJRATE);
            if(kb->fwversion == 0)
                kb->features &= ~(FEAT_FWVERSION | FEAT_FWUPDATE);
        }
    }
    if(NEEDS_FW_UPDATE(kb)){
        ckb_info("Device needs a firmware update. Please issue a fwupdate command.\n");
        kb->features = FEAT_RGB | FEAT_FWVERSION | FEAT_FWUPDATE;
        kb->active = 1;
        return 0;
    }
    if(!kb->hw && hwload_mode && HAS_FEATURES(kb, FEAT_HWLOAD)){
        if(hwloadprofile(kb, 1)){
            if(hwload_mode == 2)
                return -1;
            ckb_warn("Unable to load hardware profile\n");
            kb->features &= ~FEAT_HWLOAD;
        }
    }
    // Activate software mode if requested
    if(makeactive)
        return setactive(kb, 1);
    #ifdef DEBUG
    // 12 for each device + null terminator
    char devlist[12*(DEV_MAX-1)+1];
    int devlistpos = 0;
    for(unsigned i = 1; i < DEV_MAX; i++){
        devlistpos += sprintf(&devlist[devlistpos], "%u: 0x%x; ", i, keyboard[i].product);
    }
    ckb_info("Attached Devices: %s\n", devlist);
    #endif
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

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:

Variable Documentation

pthread_mutex_t devlistmutex = PTHREAD_MUTEX_INITIALIZER

Definition at line 11 of file device.c.

pthread_mutex_t devmutex[9] = { [0 ... 9 -1] = PTHREAD_MUTEX_INITIALIZER }

Definition at line 12 of file device.c.

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

int hwload_mode = 1

hwload_mode is defined in device.c

Definition at line 7 of file device.c.

Referenced by _start_dev(), _usbrecv(), _usbsend(), and main().

pthread_mutex_t inputmutex[9] = { [0 ... 9 -1] = PTHREAD_MUTEX_INITIALIZER }

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] = { [0 ... 9 -1] = PTHREAD_MUTEX_INITIALIZER }

Definition at line 14 of file device.c.

pthread_mutex_t macromutex2[9] = { [0 ... 9 -1] = PTHREAD_MUTEX_INITIALIZER }

Definition at line 15 of file device.c.

pthread_cond_t macrovar[9] = { [0 ... 9 -1] = PTHREAD_COND_INITIALIZER }

Definition at line 16 of file device.c.