LIRC libraries
LinuxInfraredRemoteControl
Public Attributes | List of all members
driver Struct Reference
User-space driver API

The data the driver exports i. More...

#include <driver.h>

Public Attributes

const char * device
 Name of the device (string). More...
 
int fd
 Set by the driver after init(). More...
 
uint32_t features
 Code for the features of the present device, valid after init(). More...
 
uint32_t send_mode
 Possible values are: LIRC_MODE_RAW, LIRC_MODE_PULSE, LIRC_MODE_MODE2, LIRC_MODE_LIRCCODE. More...
 
uint32_t rec_mode
 Possible values are: LIRC_MODE_RAW, LIRC_MODE_PULSE, LIRC_MODE_MODE2, LIRC_MODE_LIRCCODE. More...
 
const uint32_t code_length
 Length in bits of the code. More...
 
int(*const open_func )(const char *device)
 Function called to do basic driver setup. More...
 
int(*const init_func )(void)
 Function called for initializing the driver and the hardware. More...
 
int(*const deinit_func )(void)
 Function called when transmitting/receiving stops. More...
 
int(*const send_func )(struct ir_remote *remote, struct ir_ncode *code)
 Send data to the remote. More...
 
char *(*const rec_func )(struct ir_remote *remotes)
 Receive data from remote. More...
 
int(*const decode_func )(struct ir_remote *remote, struct decode_ctx_t *ctx)
 TODO.
 
int(*const drvctl_func )(unsigned int cmd, void *arg)
 Generic driver control function with semantics as defined by driver Returns 0 on success, else a positive error code.
 
lirc_t(*const readdata )(lirc_t timeout)
 Get length of next pulse/space from hardware. More...
 
const char * name
 Driver name, as listed by -H help and used as argument to i –driver.
 
unsigned int resolution
 The resolution in microseconds of the recorded durations when reading signals.
 
const int api_version
 API version (from version 2+). More...
 
const char * driver_version
 Driver version (free text). More...
 
const char * info
 Free text driver info. More...
 
int(*const close_func )(void)
 Hard closing, returns 0 on OK. More...
 
const char *const device_hint
 device_hint is a mean for config tools to autodetect devices. More...
 

Detailed Description

The data the driver exports i.

e., lirc accesses the driver as defined here.

Definition at line 136 of file driver.h.

Member Data Documentation

const int driver::api_version

API version (from version 2+).

Definition at line 238 of file driver.h.

int(*const driver::close_func) (void)

Hard closing, returns 0 on OK.

Definition at line 242 of file driver.h.

const uint32_t driver::code_length

Length in bits of the code.

Definition at line 164 of file driver.h.

int(*const driver::deinit_func) (void)

Function called when transmitting/receiving stops.

Zero return value indicates failure, all other return values success.

Definition at line 184 of file driver.h.

const char* driver::device

Name of the device (string).

Set by open_func() before init(), possibly using the hard-coded driver default value.

Definition at line 143 of file driver.h.

const char* const driver::device_hint

device_hint is a mean for config tools to autodetect devices.

  • /dev/tty* User selects a tty.
  • drvctl Driver supports DRVCTL_GET_DEVICES drvctl.
  • auto No device configured, a message is displayed.
  • /dev/foo* A wildcard listing possible devices, general fallback.

The following hints are not longer supported:

  • /dev/event* A devinput device
  • /dev/usb/* A serial, USB-connected port.
  • /bin/sh ... Shell command listing possible devices.
  • None No device is silently configured.

Definition at line 259 of file driver.h.

const char* driver::driver_version

Driver version (free text).

Definition at line 239 of file driver.h.

int driver::fd

Set by the driver after init().

Definition at line 146 of file driver.h.

uint32_t driver::features

Code for the features of the present device, valid after init().

Definition at line 149 of file driver.h.

const char* driver::info

Free text driver info.

Definition at line 240 of file driver.h.

int(*const driver::init_func) (void)

Function called for initializing the driver and the hardware.

Zero return value indicates failure, all other return values success.

Definition at line 178 of file driver.h.

int(*const driver::open_func) (const char *device)

Function called to do basic driver setup.

Parameters
deviceString describing what device driver should communicate with. Often (but not always) a /dev/... path.
Returns
0 if everything is fine, else positive error code.

Definition at line 172 of file driver.h.

lirc_t(*const driver::readdata) (lirc_t timeout)

Get length of next pulse/space from hardware.

Parameters
timeoutMax time to wait (us).
Returns
Length of pulse in lower 24 bits (us). PULSE_BIT is set to reflect if this is a pulse or space. 0 indicates errors.

Definition at line 222 of file driver.h.

char*(*const driver::rec_func) (struct ir_remote *remotes)

Receive data from remote.

Might close device on error conditions.

Parameters
Theremote to read from.
Returns
Formatted, statically allocated string with decoded data: "remote-name code-name code repetitions"

Definition at line 201 of file driver.h.

uint32_t driver::rec_mode

Possible values are: LIRC_MODE_RAW, LIRC_MODE_PULSE, LIRC_MODE_MODE2, LIRC_MODE_LIRCCODE.

These can be combined using bitwise or.

Definition at line 161 of file driver.h.

int(*const driver::send_func) (struct ir_remote *remote, struct ir_ncode *code)

Send data to the remote.

Parameters
remoteThe remote used to send.
codeCode(s) to send, a single code or the head of a list of codes.

Definition at line 192 of file driver.h.

uint32_t driver::send_mode

Possible values are: LIRC_MODE_RAW, LIRC_MODE_PULSE, LIRC_MODE_MODE2, LIRC_MODE_LIRCCODE.

These can be combined using bitwise or.

Definition at line 155 of file driver.h.

The documentation for this struct was generated from the following file: