1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (c) 2000-2002 Vojtech Pavlik <vojtech@ucw.cz>
4*4882a593Smuzhiyun * Copyright (c) 2001-2002, 2007 Johann Deneux <johann.deneux@gmail.com>
5*4882a593Smuzhiyun *
6*4882a593Smuzhiyun * USB/RS232 I-Force joysticks and wheels.
7*4882a593Smuzhiyun */
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun #include <linux/kernel.h>
10*4882a593Smuzhiyun #include <linux/slab.h>
11*4882a593Smuzhiyun #include <linux/input.h>
12*4882a593Smuzhiyun #include <linux/module.h>
13*4882a593Smuzhiyun #include <linux/spinlock.h>
14*4882a593Smuzhiyun #include <linux/circ_buf.h>
15*4882a593Smuzhiyun #include <linux/mutex.h>
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun /* This module provides arbitrary resource management routines.
18*4882a593Smuzhiyun * I use it to manage the device's memory.
19*4882a593Smuzhiyun * Despite the name of this module, I am *not* going to access the ioports.
20*4882a593Smuzhiyun */
21*4882a593Smuzhiyun #include <linux/ioport.h>
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun #define IFORCE_MAX_LENGTH 16
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun #define IFORCE_EFFECTS_MAX 32
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun /* Each force feedback effect is made of one core effect, which can be
29*4882a593Smuzhiyun * associated to at most to effect modifiers
30*4882a593Smuzhiyun */
31*4882a593Smuzhiyun #define FF_MOD1_IS_USED 0
32*4882a593Smuzhiyun #define FF_MOD2_IS_USED 1
33*4882a593Smuzhiyun #define FF_CORE_IS_USED 2
34*4882a593Smuzhiyun #define FF_CORE_IS_PLAYED 3 /* Effect is currently being played */
35*4882a593Smuzhiyun #define FF_CORE_SHOULD_PLAY 4 /* User wants the effect to be played */
36*4882a593Smuzhiyun #define FF_CORE_UPDATE 5 /* Effect is being updated */
37*4882a593Smuzhiyun #define FF_MODCORE_CNT 6
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun struct iforce_core_effect {
40*4882a593Smuzhiyun /* Information about where modifiers are stored in the device's memory */
41*4882a593Smuzhiyun struct resource mod1_chunk;
42*4882a593Smuzhiyun struct resource mod2_chunk;
43*4882a593Smuzhiyun unsigned long flags[BITS_TO_LONGS(FF_MODCORE_CNT)];
44*4882a593Smuzhiyun };
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun #define FF_CMD_EFFECT 0x010e
47*4882a593Smuzhiyun #define FF_CMD_ENVELOPE 0x0208
48*4882a593Smuzhiyun #define FF_CMD_MAGNITUDE 0x0303
49*4882a593Smuzhiyun #define FF_CMD_PERIOD 0x0407
50*4882a593Smuzhiyun #define FF_CMD_CONDITION 0x050a
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun #define FF_CMD_AUTOCENTER 0x4002
53*4882a593Smuzhiyun #define FF_CMD_PLAY 0x4103
54*4882a593Smuzhiyun #define FF_CMD_ENABLE 0x4201
55*4882a593Smuzhiyun #define FF_CMD_GAIN 0x4301
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun #define FF_CMD_QUERY 0xff01
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun /* Buffer for async write */
60*4882a593Smuzhiyun #define XMIT_SIZE 256
61*4882a593Smuzhiyun #define XMIT_INC(var, n) (var)+=n; (var)&= XMIT_SIZE -1
62*4882a593Smuzhiyun /* iforce::xmit_flags */
63*4882a593Smuzhiyun #define IFORCE_XMIT_RUNNING 0
64*4882a593Smuzhiyun #define IFORCE_XMIT_AGAIN 1
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun struct iforce_device {
67*4882a593Smuzhiyun u16 idvendor;
68*4882a593Smuzhiyun u16 idproduct;
69*4882a593Smuzhiyun char *name;
70*4882a593Smuzhiyun signed short *btn;
71*4882a593Smuzhiyun signed short *abs;
72*4882a593Smuzhiyun signed short *ff;
73*4882a593Smuzhiyun };
74*4882a593Smuzhiyun
75*4882a593Smuzhiyun struct iforce;
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun struct iforce_xport_ops {
78*4882a593Smuzhiyun void (*xmit)(struct iforce *iforce);
79*4882a593Smuzhiyun int (*get_id)(struct iforce *iforce, u8 id,
80*4882a593Smuzhiyun u8 *response_data, size_t *response_len);
81*4882a593Smuzhiyun int (*start_io)(struct iforce *iforce);
82*4882a593Smuzhiyun void (*stop_io)(struct iforce *iforce);
83*4882a593Smuzhiyun };
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun struct iforce {
86*4882a593Smuzhiyun struct input_dev *dev; /* Input device interface */
87*4882a593Smuzhiyun struct iforce_device *type;
88*4882a593Smuzhiyun const struct iforce_xport_ops *xport_ops;
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun spinlock_t xmit_lock;
91*4882a593Smuzhiyun /* Buffer used for asynchronous sending of bytes to the device */
92*4882a593Smuzhiyun struct circ_buf xmit;
93*4882a593Smuzhiyun unsigned char xmit_data[XMIT_SIZE];
94*4882a593Smuzhiyun unsigned long xmit_flags[1];
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun /* Force Feedback */
97*4882a593Smuzhiyun wait_queue_head_t wait;
98*4882a593Smuzhiyun struct resource device_memory;
99*4882a593Smuzhiyun struct iforce_core_effect core_effects[IFORCE_EFFECTS_MAX];
100*4882a593Smuzhiyun struct mutex mem_mutex;
101*4882a593Smuzhiyun };
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun /* Get hi and low bytes of a 16-bits int */
104*4882a593Smuzhiyun #define HI(a) ((unsigned char)((a) >> 8))
105*4882a593Smuzhiyun #define LO(a) ((unsigned char)((a) & 0xff))
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun /* For many parameters, it seems that 0x80 is a special value that should
108*4882a593Smuzhiyun * be avoided. Instead, we replace this value by 0x7f
109*4882a593Smuzhiyun */
110*4882a593Smuzhiyun #define HIFIX80(a) ((unsigned char)(((a)<0? (a)+255 : (a))>>8))
111*4882a593Smuzhiyun
112*4882a593Smuzhiyun /* Encode a time value */
113*4882a593Smuzhiyun #define TIME_SCALE(a) (a)
114*4882a593Smuzhiyun
iforce_get_id_packet(struct iforce * iforce,u8 id,u8 * response_data,size_t * response_len)115*4882a593Smuzhiyun static inline int iforce_get_id_packet(struct iforce *iforce, u8 id,
116*4882a593Smuzhiyun u8 *response_data, size_t *response_len)
117*4882a593Smuzhiyun {
118*4882a593Smuzhiyun return iforce->xport_ops->get_id(iforce, id,
119*4882a593Smuzhiyun response_data, response_len);
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun
iforce_clear_xmit_and_wake(struct iforce * iforce)122*4882a593Smuzhiyun static inline void iforce_clear_xmit_and_wake(struct iforce *iforce)
123*4882a593Smuzhiyun {
124*4882a593Smuzhiyun clear_bit(IFORCE_XMIT_RUNNING, iforce->xmit_flags);
125*4882a593Smuzhiyun wake_up_all(&iforce->wait);
126*4882a593Smuzhiyun }
127*4882a593Smuzhiyun
128*4882a593Smuzhiyun /* Public functions */
129*4882a593Smuzhiyun /* iforce-main.c */
130*4882a593Smuzhiyun int iforce_init_device(struct device *parent, u16 bustype,
131*4882a593Smuzhiyun struct iforce *iforce);
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun /* iforce-packets.c */
134*4882a593Smuzhiyun int iforce_control_playback(struct iforce*, u16 id, unsigned int);
135*4882a593Smuzhiyun void iforce_process_packet(struct iforce *iforce,
136*4882a593Smuzhiyun u8 packet_id, u8 *data, size_t len);
137*4882a593Smuzhiyun int iforce_send_packet(struct iforce *iforce, u16 cmd, unsigned char* data);
138*4882a593Smuzhiyun void iforce_dump_packet(struct iforce *iforce, char *msg, u16 cmd, unsigned char *data);
139*4882a593Smuzhiyun
140*4882a593Smuzhiyun /* iforce-ff.c */
141*4882a593Smuzhiyun int iforce_upload_periodic(struct iforce *, struct ff_effect *, struct ff_effect *);
142*4882a593Smuzhiyun int iforce_upload_constant(struct iforce *, struct ff_effect *, struct ff_effect *);
143*4882a593Smuzhiyun int iforce_upload_condition(struct iforce *, struct ff_effect *, struct ff_effect *);
144*4882a593Smuzhiyun
145*4882a593Smuzhiyun /* Public variables */
146*4882a593Smuzhiyun extern struct serio_driver iforce_serio_drv;
147*4882a593Smuzhiyun extern struct usb_driver iforce_usb_driver;
148