libx52io.h

Go to the documentation of this file.

/*
 * Saitek X52 IO driver
 *
 * Copyright (C) 2012-2020 Nirenjan Krishnan (nirenjan@nirenjan.org)
 *
 * SPDX-License-Identifier: GPL-2.0-only WITH Classpath-exception-2.0
 */
 
#ifndef LIBX52IO_H
#define LIBX52IO_H
 
#include <stdint.h>
#include <stdbool.h>
 
#ifndef LIBX52IO_API
# if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 303
#  define LIBX52IO_API __attribute__((visibility("default")))
# elif defined(_WIN32)
#  define LIBX52IO_API __declspec(dllexport)
# else
#  define LIBX52IO_API
# endif
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct libx52io_context;
 
typedef struct libx52io_context libx52io_context;
 
typedef enum {
    LIBX52IO_SUCCESS,
 
    LIBX52IO_ERROR_INIT_FAILURE,
 
    LIBX52IO_ERROR_NO_DEVICE,
 
    LIBX52IO_ERROR_INVALID,
 
    LIBX52IO_ERROR_CONN,
 
    LIBX52IO_ERROR_IO,
 
    LIBX52IO_ERROR_TIMEOUT,
} libx52io_error_code;
 
typedef enum {
    LIBX52IO_AXIS_X,
 
    LIBX52IO_AXIS_Y,
 
    LIBX52IO_AXIS_RZ,
 
    LIBX52IO_AXIS_Z,
 
    LIBX52IO_AXIS_RX,
 
    LIBX52IO_AXIS_RY,
 
    LIBX52IO_AXIS_SLIDER,
 
    LIBX52IO_AXIS_THUMBX,
 
    LIBX52IO_AXIS_THUMBY,
 
    LIBX52IO_AXIS_HATX,
 
    LIBX52IO_AXIS_HATY,
 
    LIBX52IO_AXIS_MAX
} libx52io_axis;
 
typedef enum {
    LIBX52IO_BTN_TRIGGER,
 
    LIBX52IO_BTN_TRIGGER_2,
 
    LIBX52IO_BTN_FIRE,
 
    LIBX52IO_BTN_PINKY,
 
    LIBX52IO_BTN_A,
 
    LIBX52IO_BTN_B,
 
    LIBX52IO_BTN_C,
 
    LIBX52IO_BTN_D,
 
    LIBX52IO_BTN_E,
 
    LIBX52IO_BTN_T1_UP,
 
    LIBX52IO_BTN_T1_DN,
 
    LIBX52IO_BTN_T2_UP,
 
    LIBX52IO_BTN_T2_DN,
 
    LIBX52IO_BTN_T3_UP,
 
    LIBX52IO_BTN_T3_DN,
 
    LIBX52IO_BTN_POV_1_N,
 
    LIBX52IO_BTN_POV_1_E,
 
    LIBX52IO_BTN_POV_1_S,
 
    LIBX52IO_BTN_POV_1_W,
 
    LIBX52IO_BTN_POV_2_N,
 
    LIBX52IO_BTN_POV_2_E,
 
    LIBX52IO_BTN_POV_2_S,
 
    LIBX52IO_BTN_POV_2_W,
 
    LIBX52IO_BTN_CLUTCH,
 
    LIBX52IO_BTN_MOUSE_PRIMARY,
 
    LIBX52IO_BTN_MOUSE_SECONDARY,
 
    LIBX52IO_BTN_MOUSE_SCROLL_UP,
 
    LIBX52IO_BTN_MOUSE_SCROLL_DN,
 
    LIBX52IO_BTN_FUNCTION,
 
    LIBX52IO_BTN_START_STOP,
 
    LIBX52IO_BTN_RESET,
 
    LIBX52IO_BTN_PG_UP,
 
    LIBX52IO_BTN_PG_DN,
 
    LIBX52IO_BTN_UP,
 
    LIBX52IO_BTN_DN,
 
    LIBX52IO_BTN_SELECT,
 
    LIBX52IO_BTN_MODE_1,
 
    LIBX52IO_BTN_MODE_2,
 
    LIBX52IO_BTN_MODE_3,
 
    LIBX52IO_BUTTON_MAX
} libx52io_button;
 
struct libx52io_report {
    int32_t axis[LIBX52IO_AXIS_MAX];
 
    bool button[LIBX52IO_BUTTON_MAX];
 
    uint8_t mode;
 
    uint8_t hat;
};
 
typedef struct libx52io_report libx52io_report;
 
LIBX52IO_API int libx52io_init(libx52io_context **ctx);
 
LIBX52IO_API void libx52io_exit(libx52io_context *ctx);
 
LIBX52IO_API int libx52io_open(libx52io_context *ctx);
 
LIBX52IO_API int libx52io_close(libx52io_context *ctx);
 
LIBX52IO_API int libx52io_read_timeout(libx52io_context *ctx, libx52io_report *report, int timeout);
 
LIBX52IO_API int libx52io_read(libx52io_context *ctx, libx52io_report *report);
 
LIBX52IO_API int libx52io_get_axis_range(libx52io_context *ctx, libx52io_axis axis, int32_t *min, int32_t *max);
 
LIBX52IO_API const char *libx52io_strerror(libx52io_error_code code);
 
LIBX52IO_API const char *libx52io_axis_to_str(libx52io_axis axis);
 
LIBX52IO_API const char *libx52io_button_to_str(libx52io_button button);
 
LIBX52IO_API int libx52io_axis_from_str(const char *str, libx52io_axis *axis);
 
LIBX52IO_API int libx52io_button_from_str(const char *str, libx52io_button *button);
 
LIBX52IO_API int libx52io_axis_from_str_nocase(const char *str, libx52io_axis *axis);
 
LIBX52IO_API int libx52io_button_from_str_nocase(const char *str, libx52io_button *button);
 
LIBX52IO_API uint16_t libx52io_get_vendor_id(libx52io_context *ctx);
 
LIBX52IO_API uint16_t libx52io_get_product_id(libx52io_context *ctx);
 
LIBX52IO_API uint16_t libx52io_get_device_version(libx52io_context *ctx);
 
LIBX52IO_API const char *libx52io_get_manufacturer_string(libx52io_context *ctx);
 
LIBX52IO_API const char *libx52io_get_product_string(libx52io_context *ctx);
 
LIBX52IO_API const char *libx52io_get_serial_number_string(libx52io_context *ctx);
 
#ifdef __cplusplus
}
#endif
 
#endif // !defined LIBX52IO_H