joystick/iforce/iforce.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  *  Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
0004  *  Copyright (c) 2001-2002, 2007 Johann Deneux <johann.deneux@gmail.com>
0005  *
0006  *  USB/RS232 I-Force joysticks and wheels.
0007  */
0008
0009 #include <linux/kernel.h>
0010 #include <linux/slab.h>
0011 #include <linux/input.h>
0012 #include <linux/module.h>
0013 #include <linux/spinlock.h>
0014 #include <linux/circ_buf.h>
0015 #include <linux/mutex.h>
0016
0017 /* This module provides arbitrary resource management routines.
0018  * I use it to manage the device's memory.
0019  * Despite the name of this module, I am *not* going to access the ioports.
0020  */
0021 #include <linux/ioport.h>
0022
0023
0024 #define IFORCE_MAX_LENGTH   16
0025
0026 #define IFORCE_EFFECTS_MAX  32
0027
0028 /* Each force feedback effect is made of one core effect, which can be
0029  * associated to at most to effect modifiers
0030  */
0031 #define FF_MOD1_IS_USED     0
0032 #define FF_MOD2_IS_USED     1
0033 #define FF_CORE_IS_USED     2
0034 #define FF_CORE_IS_PLAYED   3   /* Effect is currently being played */
0035 #define FF_CORE_SHOULD_PLAY 4   /* User wants the effect to be played */
0036 #define FF_CORE_UPDATE      5   /* Effect is being updated */
0037 #define FF_MODCORE_CNT      6
0038
0039 struct iforce_core_effect {
0040     /* Information about where modifiers are stored in the device's memory */
0041     struct resource mod1_chunk;
0042     struct resource mod2_chunk;
0043     unsigned long flags[BITS_TO_LONGS(FF_MODCORE_CNT)];
0044 };
0045
0046 #define FF_CMD_EFFECT       0x010e
0047 #define FF_CMD_ENVELOPE     0x0208
0048 #define FF_CMD_MAGNITUDE    0x0303
0049 #define FF_CMD_PERIOD       0x0407
0050 #define FF_CMD_CONDITION    0x050a
0051
0052 #define FF_CMD_AUTOCENTER   0x4002
0053 #define FF_CMD_PLAY     0x4103
0054 #define FF_CMD_ENABLE       0x4201
0055 #define FF_CMD_GAIN     0x4301
0056
0057 #define FF_CMD_QUERY        0xff01
0058
0059 /* Buffer for async write */
0060 #define XMIT_SIZE       256
0061 #define XMIT_INC(var, n)    (var)+=n; (var)&= XMIT_SIZE -1
0062 /* iforce::xmit_flags */
0063 #define IFORCE_XMIT_RUNNING 0
0064 #define IFORCE_XMIT_AGAIN   1
0065
0066 struct iforce_device {
0067     u16 idvendor;
0068     u16 idproduct;
0069     char *name;
0070     signed short *btn;
0071     signed short *abs;
0072     signed short *ff;
0073 };
0074
0075 struct iforce;
0076
0077 struct iforce_xport_ops {
0078     void (*xmit)(struct iforce *iforce);
0079     int (*get_id)(struct iforce *iforce, u8 id,
0080               u8 *response_data, size_t *response_len);
0081     int (*start_io)(struct iforce *iforce);
0082     void (*stop_io)(struct iforce *iforce);
0083 };
0084
0085 struct iforce {
0086     struct input_dev *dev;      /* Input device interface */
0087     struct iforce_device *type;
0088     const struct iforce_xport_ops *xport_ops;
0089
0090     spinlock_t xmit_lock;
0091     /* Buffer used for asynchronous sending of bytes to the device */
0092     struct circ_buf xmit;
0093     unsigned char xmit_data[XMIT_SIZE];
0094     unsigned long xmit_flags[1];
0095
0096                     /* Force Feedback */
0097     wait_queue_head_t wait;
0098     struct resource device_memory;
0099     struct iforce_core_effect core_effects[IFORCE_EFFECTS_MAX];
0100     struct mutex mem_mutex;
0101 };
0102
0103 /* Get hi and low bytes of a 16-bits int */
0104 #define HI(a)   ((unsigned char)((a) >> 8))
0105 #define LO(a)   ((unsigned char)((a) & 0xff))
0106
0107 /* For many parameters, it seems that 0x80 is a special value that should
0108  * be avoided. Instead, we replace this value by 0x7f
0109  */
0110 #define HIFIX80(a) ((unsigned char)(((a)<0? (a)+255 : (a))>>8))
0111
0112 /* Encode a time value */
0113 #define TIME_SCALE(a)   (a)
0114
0115 static inline int iforce_get_id_packet(struct iforce *iforce, u8 id,
0116                        u8 *response_data, size_t *response_len)
0117 {
0118     return iforce->xport_ops->get_id(iforce, id,
0119                      response_data, response_len);
0120 }
0121
0122 static inline void iforce_clear_xmit_and_wake(struct iforce *iforce)
0123 {
0124     clear_bit(IFORCE_XMIT_RUNNING, iforce->xmit_flags);
0125     wake_up_all(&iforce->wait);
0126 }
0127
0128 /* Public functions */
0129 /* iforce-main.c */
0130 int iforce_init_device(struct device *parent, u16 bustype,
0131                struct iforce *iforce);
0132
0133 /* iforce-packets.c */
0134 int iforce_control_playback(struct iforce*, u16 id, unsigned int);
0135 void iforce_process_packet(struct iforce *iforce,
0136                u8 packet_id, u8 *data, size_t len);
0137 int iforce_send_packet(struct iforce *iforce, u16 cmd, unsigned char* data);
0138 void iforce_dump_packet(struct iforce *iforce, char *msg, u16 cmd, unsigned char *data);
0139
0140 /* iforce-ff.c */
0141 int iforce_upload_periodic(struct iforce *, struct ff_effect *, struct ff_effect *);
0142 int iforce_upload_constant(struct iforce *, struct ff_effect *, struct ff_effect *);
0143 int iforce_upload_condition(struct iforce *, struct ff_effect *, struct ff_effect *);
0144
0145 /* Public variables */
0146 extern struct serio_driver iforce_serio_drv;
0147 extern struct usb_driver iforce_usb_driver;