1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Header file for the compaq Micro MFD
4*4882a593Smuzhiyun */
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun #ifndef _MFD_IPAQ_MICRO_H_
7*4882a593Smuzhiyun #define _MFD_IPAQ_MICRO_H_
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun #include <linux/spinlock.h>
10*4882a593Smuzhiyun #include <linux/completion.h>
11*4882a593Smuzhiyun #include <linux/list.h>
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun #define TX_BUF_SIZE 32
14*4882a593Smuzhiyun #define RX_BUF_SIZE 16
15*4882a593Smuzhiyun #define CHAR_SOF 0x02
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun /*
18*4882a593Smuzhiyun * These are the different messages that can be sent to the microcontroller
19*4882a593Smuzhiyun * to control various aspects.
20*4882a593Smuzhiyun */
21*4882a593Smuzhiyun #define MSG_VERSION 0x0
22*4882a593Smuzhiyun #define MSG_KEYBOARD 0x2
23*4882a593Smuzhiyun #define MSG_TOUCHSCREEN 0x3
24*4882a593Smuzhiyun #define MSG_EEPROM_READ 0x4
25*4882a593Smuzhiyun #define MSG_EEPROM_WRITE 0x5
26*4882a593Smuzhiyun #define MSG_THERMAL_SENSOR 0x6
27*4882a593Smuzhiyun #define MSG_NOTIFY_LED 0x8
28*4882a593Smuzhiyun #define MSG_BATTERY 0x9
29*4882a593Smuzhiyun #define MSG_SPI_READ 0xb
30*4882a593Smuzhiyun #define MSG_SPI_WRITE 0xc
31*4882a593Smuzhiyun #define MSG_BACKLIGHT 0xd /* H3600 only */
32*4882a593Smuzhiyun #define MSG_CODEC_CTRL 0xe /* H3100 only */
33*4882a593Smuzhiyun #define MSG_DISPLAY_CTRL 0xf /* H3100 only */
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun /* state of receiver parser */
36*4882a593Smuzhiyun enum rx_state {
37*4882a593Smuzhiyun STATE_SOF = 0, /* Next byte should be start of frame */
38*4882a593Smuzhiyun STATE_ID, /* Next byte is ID & message length */
39*4882a593Smuzhiyun STATE_DATA, /* Next byte is a data byte */
40*4882a593Smuzhiyun STATE_CHKSUM /* Next byte should be checksum */
41*4882a593Smuzhiyun };
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun /**
44*4882a593Smuzhiyun * struct ipaq_micro_txdev - TX state
45*4882a593Smuzhiyun * @len: length of message in TX buffer
46*4882a593Smuzhiyun * @index: current index into TX buffer
47*4882a593Smuzhiyun * @buf: TX buffer
48*4882a593Smuzhiyun */
49*4882a593Smuzhiyun struct ipaq_micro_txdev {
50*4882a593Smuzhiyun u8 len;
51*4882a593Smuzhiyun u8 index;
52*4882a593Smuzhiyun u8 buf[TX_BUF_SIZE];
53*4882a593Smuzhiyun };
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun /**
56*4882a593Smuzhiyun * struct ipaq_micro_rxdev - RX state
57*4882a593Smuzhiyun * @state: context of RX state machine
58*4882a593Smuzhiyun * @chksum: calculated checksum
59*4882a593Smuzhiyun * @id: message ID from packet
60*4882a593Smuzhiyun * @len: RX buffer length
61*4882a593Smuzhiyun * @index: RX buffer index
62*4882a593Smuzhiyun * @buf: RX buffer
63*4882a593Smuzhiyun */
64*4882a593Smuzhiyun struct ipaq_micro_rxdev {
65*4882a593Smuzhiyun enum rx_state state;
66*4882a593Smuzhiyun unsigned char chksum;
67*4882a593Smuzhiyun u8 id;
68*4882a593Smuzhiyun unsigned int len;
69*4882a593Smuzhiyun unsigned int index;
70*4882a593Smuzhiyun u8 buf[RX_BUF_SIZE];
71*4882a593Smuzhiyun };
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun /**
74*4882a593Smuzhiyun * struct ipaq_micro_msg - message to the iPAQ microcontroller
75*4882a593Smuzhiyun * @id: 4-bit ID of the message
76*4882a593Smuzhiyun * @tx_len: length of TX data
77*4882a593Smuzhiyun * @tx_data: TX data to send
78*4882a593Smuzhiyun * @rx_len: length of receieved RX data
79*4882a593Smuzhiyun * @rx_data: RX data to recieve
80*4882a593Smuzhiyun * @ack: a completion that will be completed when RX is complete
81*4882a593Smuzhiyun * @node: list node if message gets queued
82*4882a593Smuzhiyun */
83*4882a593Smuzhiyun struct ipaq_micro_msg {
84*4882a593Smuzhiyun u8 id;
85*4882a593Smuzhiyun u8 tx_len;
86*4882a593Smuzhiyun u8 tx_data[TX_BUF_SIZE];
87*4882a593Smuzhiyun u8 rx_len;
88*4882a593Smuzhiyun u8 rx_data[RX_BUF_SIZE];
89*4882a593Smuzhiyun struct completion ack;
90*4882a593Smuzhiyun struct list_head node;
91*4882a593Smuzhiyun };
92*4882a593Smuzhiyun
93*4882a593Smuzhiyun /**
94*4882a593Smuzhiyun * struct ipaq_micro - iPAQ microcontroller state
95*4882a593Smuzhiyun * @dev: corresponding platform device
96*4882a593Smuzhiyun * @base: virtual memory base for underlying serial device
97*4882a593Smuzhiyun * @sdlc: virtual memory base for Synchronous Data Link Controller
98*4882a593Smuzhiyun * @version: version string
99*4882a593Smuzhiyun * @tx: TX state
100*4882a593Smuzhiyun * @rx: RX state
101*4882a593Smuzhiyun * @lock: lock for this state container
102*4882a593Smuzhiyun * @msg: current message
103*4882a593Smuzhiyun * @queue: message queue
104*4882a593Smuzhiyun * @key: callback for asynchronous key events
105*4882a593Smuzhiyun * @key_data: data to pass along with key events
106*4882a593Smuzhiyun * @ts: callback for asynchronous touchscreen events
107*4882a593Smuzhiyun * @ts_data: data to pass along with key events
108*4882a593Smuzhiyun */
109*4882a593Smuzhiyun struct ipaq_micro {
110*4882a593Smuzhiyun struct device *dev;
111*4882a593Smuzhiyun void __iomem *base;
112*4882a593Smuzhiyun void __iomem *sdlc;
113*4882a593Smuzhiyun char version[5];
114*4882a593Smuzhiyun struct ipaq_micro_txdev tx; /* transmit ISR state */
115*4882a593Smuzhiyun struct ipaq_micro_rxdev rx; /* receive ISR state */
116*4882a593Smuzhiyun spinlock_t lock;
117*4882a593Smuzhiyun struct ipaq_micro_msg *msg;
118*4882a593Smuzhiyun struct list_head queue;
119*4882a593Smuzhiyun void (*key) (void *data, int len, unsigned char *rxdata);
120*4882a593Smuzhiyun void *key_data;
121*4882a593Smuzhiyun void (*ts) (void *data, int len, unsigned char *rxdata);
122*4882a593Smuzhiyun void *ts_data;
123*4882a593Smuzhiyun };
124*4882a593Smuzhiyun
125*4882a593Smuzhiyun extern int
126*4882a593Smuzhiyun ipaq_micro_tx_msg(struct ipaq_micro *micro, struct ipaq_micro_msg *msg);
127*4882a593Smuzhiyun
128*4882a593Smuzhiyun static inline int
ipaq_micro_tx_msg_sync(struct ipaq_micro * micro,struct ipaq_micro_msg * msg)129*4882a593Smuzhiyun ipaq_micro_tx_msg_sync(struct ipaq_micro *micro,
130*4882a593Smuzhiyun struct ipaq_micro_msg *msg)
131*4882a593Smuzhiyun {
132*4882a593Smuzhiyun int ret;
133*4882a593Smuzhiyun
134*4882a593Smuzhiyun init_completion(&msg->ack);
135*4882a593Smuzhiyun ret = ipaq_micro_tx_msg(micro, msg);
136*4882a593Smuzhiyun wait_for_completion(&msg->ack);
137*4882a593Smuzhiyun
138*4882a593Smuzhiyun return ret;
139*4882a593Smuzhiyun }
140*4882a593Smuzhiyun
141*4882a593Smuzhiyun static inline int
ipaq_micro_tx_msg_async(struct ipaq_micro * micro,struct ipaq_micro_msg * msg)142*4882a593Smuzhiyun ipaq_micro_tx_msg_async(struct ipaq_micro *micro,
143*4882a593Smuzhiyun struct ipaq_micro_msg *msg)
144*4882a593Smuzhiyun {
145*4882a593Smuzhiyun init_completion(&msg->ack);
146*4882a593Smuzhiyun return ipaq_micro_tx_msg(micro, msg);
147*4882a593Smuzhiyun }
148*4882a593Smuzhiyun
149*4882a593Smuzhiyun #endif /* _MFD_IPAQ_MICRO_H_ */
150