libx52.h

Go to the documentation of this file.

/*
 * Saitek X52 Pro MFD & LED driver
 *
 * Copyright (C) 2012-2020 Nirenjan Krishnan (nirenjan@nirenjan.org)
 *
 * SPDX-License-Identifier: GPL-2.0-only WITH Classpath-exception-2.0
 */
 
#ifndef LIBX52_H
#define LIBX52_H
 
#include <time.h>
#include <stdint.h>
#include <stdbool.h>
 
#ifndef LIBX52_API
# if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 303
#  define LIBX52_API __attribute__((visibility("default")))
# elif defined(_WIN32)
#  define LIBX52_API __declspec(dllexport)
# else
#  define LIBX52_API
# endif
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct libx52_device;
 
typedef struct libx52_device libx52_device;
 
typedef enum {
    LIBX52_CLOCK_1,
 
    LIBX52_CLOCK_2,
 
    LIBX52_CLOCK_3,
} libx52_clock_id;
 
typedef enum {
    LIBX52_CLOCK_FORMAT_12HR,
 
    LIBX52_CLOCK_FORMAT_24HR,
} libx52_clock_format;
 
typedef enum {
    LIBX52_DATE_FORMAT_DDMMYY,
 
    LIBX52_DATE_FORMAT_MMDDYY,
 
    LIBX52_DATE_FORMAT_YYMMDD,
} libx52_date_format;
 
typedef enum {
    LIBX52_LED_FIRE = 0x01,
 
    LIBX52_LED_A = 0x02,
 
    LIBX52_LED_B = 0x04,
 
    LIBX52_LED_D = 0x06,
 
    LIBX52_LED_E = 0x08,
 
    LIBX52_LED_T1 = 0x0a,
 
    LIBX52_LED_T2 = 0x0c,
 
    LIBX52_LED_T3 = 0x0e,
 
    LIBX52_LED_POV = 0x10,
 
    LIBX52_LED_CLUTCH = 0x12,
 
    LIBX52_LED_THROTTLE = 0x14,
} libx52_led_id;
 
typedef enum {
    LIBX52_LED_STATE_OFF,
 
    LIBX52_LED_STATE_ON,
 
    LIBX52_LED_STATE_RED,
 
    LIBX52_LED_STATE_AMBER,
 
    LIBX52_LED_STATE_GREEN,
} libx52_led_state;
 
typedef enum {
    LIBX52_SUCCESS = 0,
 
    LIBX52_ERROR_INIT_FAILURE,
 
    LIBX52_ERROR_OUT_OF_MEMORY,
 
    LIBX52_ERROR_INVALID_PARAM,
 
    LIBX52_ERROR_NOT_SUPPORTED,
 
    LIBX52_ERROR_TRY_AGAIN,
 
    LIBX52_ERROR_OUT_OF_RANGE,
 
    LIBX52_ERROR_USB_FAILURE,
 
    LIBX52_ERROR_IO,
 
    LIBX52_ERROR_PERM,
 
    LIBX52_ERROR_NO_DEVICE,
 
    LIBX52_ERROR_NOT_FOUND,
 
    LIBX52_ERROR_BUSY,
 
    LIBX52_ERROR_TIMEOUT,
 
    LIBX52_ERROR_OVERFLOW,
 
    LIBX52_ERROR_PIPE,
 
    LIBX52_ERROR_INTERRUPTED,
} libx52_error_code;
 
typedef enum {
    LIBX52_FEATURE_LED,
} libx52_feature;
 
LIBX52_API int libx52_init(libx52_device ** dev);
 
LIBX52_API void libx52_exit(libx52_device *dev);
 
LIBX52_API int libx52_connect(libx52_device *dev);
 
LIBX52_API int libx52_disconnect(libx52_device *dev);
 
LIBX52_API bool libx52_is_connected(libx52_device *dev);
 
LIBX52_API int libx52_set_text(libx52_device *x52, uint8_t line, const char *text, uint8_t length);
 
LIBX52_API int libx52_set_led_state(libx52_device *x52,
                         libx52_led_id led,
                         libx52_led_state state);
 
LIBX52_API int libx52_set_clock(libx52_device *x52, time_t time, int local);
 
LIBX52_API int libx52_set_clock_timezone(libx52_device *x52,
                              libx52_clock_id clock,
                              int offset);
 
LIBX52_API int libx52_set_clock_format(libx52_device *x52,
                            libx52_clock_id clock,
                            libx52_clock_format format);
 
LIBX52_API int libx52_set_time(libx52_device *x52, uint8_t hour, uint8_t minute);
 
LIBX52_API int libx52_set_date(libx52_device *x52, uint8_t dd, uint8_t mm, uint8_t yy);
 
LIBX52_API int libx52_set_date_format(libx52_device *x52, libx52_date_format format);
 
LIBX52_API int libx52_set_brightness(libx52_device *x52, uint8_t mfd, uint16_t brightness);
 
LIBX52_API int libx52_set_shift(libx52_device *x52, uint8_t state);
 
LIBX52_API int libx52_set_blink(libx52_device *x52, uint8_t state);
 
LIBX52_API int libx52_update(libx52_device *x52);
 
LIBX52_API int libx52_vendor_command(libx52_device *x52, uint16_t index, uint16_t value);
 
LIBX52_API int libx52_check_feature(libx52_device *x52, libx52_feature feature);
 
LIBX52_API const char *libx52_strerror(libx52_error_code error);
 
LIBX52_API const char *libx52_clock_id_to_str(libx52_clock_id id);
 
LIBX52_API const char *libx52_clock_format_to_str(libx52_clock_format format);
 
LIBX52_API const char *libx52_date_format_to_str(libx52_date_format format);
 
LIBX52_API const char *libx52_led_id_to_str(libx52_led_id id);
 
LIBX52_API const char *libx52_led_state_to_str(libx52_led_state state);
 
#ifdef __cplusplus
}
#endif
 
#endif /* !defined LIBX52_H */