driver.h

Go to the documentation of this file.

/****************************************************************************
** driver.h **************************************************************
****************************************************************************
*
* Copyright (C) 1999 Christoph Bartelmus <lirc@bartelmus.de>
*
*/

#ifndef _HARDWARE_H
#define _HARDWARE_H

#include <glob.h>
#include <stdint.h>

#ifdef HAVE_KERNEL_LIRC_H
#include <linux/lirc.h>
#else
#include "media/lirc.h"
#endif

#include "lirc/ir_remote_types.h"
#include "lirc/curl_poll.h"

#ifndef MAXPATHLEN
#define MAXPATHLEN 4096
#endif

#define HAVE_SERVER_VERSION 1

int get_server_version(void);


#ifdef __cplusplus
extern "C" {
#endif

#define DRV_ERR_NOT_IMPLEMENTED         1

int default_open(const char* path);

int default_close(void);

int default_drvctl(unsigned int cmd, void* arg);

struct option_t {
        char    key[32];
        char    value[64];
};

int drv_handle_options(const char* options);


#define DRVCTL_GET_STATE                1

#define DRVCTL_SEND_SPACE               2

#define DRVCTL_SET_OPTION               3

#define DRVCTL_GET_RAW_CODELENGTH       4

#define DRVCTL_GET_DEVICES              5

#define DRVCTL_FREE_DEVICES             6

#define DRVCTL_NOTIFY_DECODE            7

#define  DRVCTL_MAX                     128

#define  DRV_ERR_NOT_IMPLEMENTED        1

#define  DRV_ERR_BAD_STATE              2

#define  DRV_ERR_BAD_OPTION             3

#define  DRV_ERR_BAD_VALUE              4

#define  DRV_ERR_ENUM_EMPTY             5

#define  DRV_ERR_INTERNAL               6

struct driver {
// Old-style implicit API version 1:

        const char* device;

        int             fd;

        uint32_t        features;

        uint32_t        send_mode;

        uint32_t        rec_mode;

        const uint32_t  code_length;

        int (*const open_func) (const char* device);

        int (*const init_func)(void);

        int (*const deinit_func) (void);

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

        char* (*const rec_func)(struct ir_remote* remotes);

        int (*const decode_func)(struct ir_remote* remote,
                                 struct decode_ctx_t* ctx);

        int (*const drvctl_func)(unsigned int cmd, void* arg);

        lirc_t (*const readdata)(lirc_t timeout);

        const char*     name;

        unsigned int    resolution;

/* API version 2 addons: */

        const int       api_version;            
        const char*     driver_version;         
        const char*     info;                   
        int (*const close_func)(void);          
/* API version 3 addons: */
        const char* const  device_hint;
};

#ifdef IN_DRIVER

extern struct driver drv;
#endif

extern const struct driver* const curr_driver;


#ifdef __cplusplus
}
#endif

#endif