1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2015-2018, Intel Corporation.
6 #define pr_fmt(fmt) "kcs-bmc: " fmt
8 #include <linux/errno.h>
10 #include <linux/ipmi_bmc.h>
11 #include <linux/module.h>
12 #include <linux/platform_device.h>
13 #include <linux/poll.h>
14 #include <linux/sched.h>
15 #include <linux/slab.h>
19 #define KCS_MSG_BUFSIZ 1000
21 #define KCS_ZERO_DATA 0
24 /* IPMI 2.0 - Table 9-1, KCS Interface Status Register Bits */
25 #define KCS_STATUS_STATE(state) (state << 6)
26 #define KCS_STATUS_STATE_MASK GENMASK(7, 6)
27 #define KCS_STATUS_CMD_DAT BIT(3)
28 #define KCS_STATUS_SMS_ATN BIT(2)
29 #define KCS_STATUS_IBF BIT(1)
30 #define KCS_STATUS_OBF BIT(0)
32 /* IPMI 2.0 - Table 9-2, KCS Interface State Bits */
40 /* IPMI 2.0 - Table 9-3, KCS Interface Control Codes */
41 #define KCS_CMD_GET_STATUS_ABORT 0x60
42 #define KCS_CMD_WRITE_START 0x61
43 #define KCS_CMD_WRITE_END 0x62
44 #define KCS_CMD_READ_BYTE 0x68
46 static inline u8 read_data(struct kcs_bmc *kcs_bmc)
48 return kcs_bmc->io_inputb(kcs_bmc, kcs_bmc->ioreg.idr);
51 static inline void write_data(struct kcs_bmc *kcs_bmc, u8 data)
53 kcs_bmc->io_outputb(kcs_bmc, kcs_bmc->ioreg.odr, data);
56 static inline u8 read_status(struct kcs_bmc *kcs_bmc)
58 return kcs_bmc->io_inputb(kcs_bmc, kcs_bmc->ioreg.str);
61 static inline void write_status(struct kcs_bmc *kcs_bmc, u8 data)
63 kcs_bmc->io_outputb(kcs_bmc, kcs_bmc->ioreg.str, data);
66 static void update_status_bits(struct kcs_bmc *kcs_bmc, u8 mask, u8 val)
68 u8 tmp = read_status(kcs_bmc);
73 write_status(kcs_bmc, tmp);
76 static inline void set_state(struct kcs_bmc *kcs_bmc, u8 state)
78 update_status_bits(kcs_bmc, KCS_STATUS_STATE_MASK,
79 KCS_STATUS_STATE(state));
82 static void kcs_force_abort(struct kcs_bmc *kcs_bmc)
84 set_state(kcs_bmc, ERROR_STATE);
86 write_data(kcs_bmc, KCS_ZERO_DATA);
88 kcs_bmc->phase = KCS_PHASE_ERROR;
89 kcs_bmc->data_in_avail = false;
90 kcs_bmc->data_in_idx = 0;
93 static void kcs_bmc_handle_data(struct kcs_bmc *kcs_bmc)
97 switch (kcs_bmc->phase) {
98 case KCS_PHASE_WRITE_START:
99 kcs_bmc->phase = KCS_PHASE_WRITE_DATA;
102 case KCS_PHASE_WRITE_DATA:
103 if (kcs_bmc->data_in_idx < KCS_MSG_BUFSIZ) {
104 set_state(kcs_bmc, WRITE_STATE);
105 write_data(kcs_bmc, KCS_ZERO_DATA);
106 kcs_bmc->data_in[kcs_bmc->data_in_idx++] =
109 kcs_force_abort(kcs_bmc);
110 kcs_bmc->error = KCS_LENGTH_ERROR;
114 case KCS_PHASE_WRITE_END_CMD:
115 if (kcs_bmc->data_in_idx < KCS_MSG_BUFSIZ) {
116 set_state(kcs_bmc, READ_STATE);
117 kcs_bmc->data_in[kcs_bmc->data_in_idx++] =
119 kcs_bmc->phase = KCS_PHASE_WRITE_DONE;
120 kcs_bmc->data_in_avail = true;
121 wake_up_interruptible(&kcs_bmc->queue);
123 kcs_force_abort(kcs_bmc);
124 kcs_bmc->error = KCS_LENGTH_ERROR;
129 if (kcs_bmc->data_out_idx == kcs_bmc->data_out_len)
130 set_state(kcs_bmc, IDLE_STATE);
132 data = read_data(kcs_bmc);
133 if (data != KCS_CMD_READ_BYTE) {
134 set_state(kcs_bmc, ERROR_STATE);
135 write_data(kcs_bmc, KCS_ZERO_DATA);
139 if (kcs_bmc->data_out_idx == kcs_bmc->data_out_len) {
140 write_data(kcs_bmc, KCS_ZERO_DATA);
141 kcs_bmc->phase = KCS_PHASE_IDLE;
146 kcs_bmc->data_out[kcs_bmc->data_out_idx++]);
149 case KCS_PHASE_ABORT_ERROR1:
150 set_state(kcs_bmc, READ_STATE);
152 write_data(kcs_bmc, kcs_bmc->error);
153 kcs_bmc->phase = KCS_PHASE_ABORT_ERROR2;
156 case KCS_PHASE_ABORT_ERROR2:
157 set_state(kcs_bmc, IDLE_STATE);
159 write_data(kcs_bmc, KCS_ZERO_DATA);
160 kcs_bmc->phase = KCS_PHASE_IDLE;
164 kcs_force_abort(kcs_bmc);
169 static void kcs_bmc_handle_cmd(struct kcs_bmc *kcs_bmc)
173 set_state(kcs_bmc, WRITE_STATE);
174 write_data(kcs_bmc, KCS_ZERO_DATA);
176 cmd = read_data(kcs_bmc);
178 case KCS_CMD_WRITE_START:
179 kcs_bmc->phase = KCS_PHASE_WRITE_START;
180 kcs_bmc->error = KCS_NO_ERROR;
181 kcs_bmc->data_in_avail = false;
182 kcs_bmc->data_in_idx = 0;
185 case KCS_CMD_WRITE_END:
186 if (kcs_bmc->phase != KCS_PHASE_WRITE_DATA) {
187 kcs_force_abort(kcs_bmc);
191 kcs_bmc->phase = KCS_PHASE_WRITE_END_CMD;
194 case KCS_CMD_GET_STATUS_ABORT:
195 if (kcs_bmc->error == KCS_NO_ERROR)
196 kcs_bmc->error = KCS_ABORTED_BY_COMMAND;
198 kcs_bmc->phase = KCS_PHASE_ABORT_ERROR1;
199 kcs_bmc->data_in_avail = false;
200 kcs_bmc->data_in_idx = 0;
204 kcs_force_abort(kcs_bmc);
205 kcs_bmc->error = KCS_ILLEGAL_CONTROL_CODE;
210 int kcs_bmc_handle_event(struct kcs_bmc *kcs_bmc)
216 spin_lock_irqsave(&kcs_bmc->lock, flags);
218 if (!kcs_bmc->running) {
219 kcs_force_abort(kcs_bmc);
224 status = read_status(kcs_bmc) & (KCS_STATUS_IBF | KCS_STATUS_CMD_DAT);
227 case KCS_STATUS_IBF | KCS_STATUS_CMD_DAT:
228 kcs_bmc_handle_cmd(kcs_bmc);
232 kcs_bmc_handle_data(kcs_bmc);
241 spin_unlock_irqrestore(&kcs_bmc->lock, flags);
245 EXPORT_SYMBOL(kcs_bmc_handle_event);
247 static inline struct kcs_bmc *to_kcs_bmc(struct file *filp)
249 return container_of(filp->private_data, struct kcs_bmc, miscdev);
252 static int kcs_bmc_open(struct inode *inode, struct file *filp)
254 struct kcs_bmc *kcs_bmc = to_kcs_bmc(filp);
257 spin_lock_irq(&kcs_bmc->lock);
258 if (!kcs_bmc->running)
259 kcs_bmc->running = 1;
262 spin_unlock_irq(&kcs_bmc->lock);
267 static __poll_t kcs_bmc_poll(struct file *filp, poll_table *wait)
269 struct kcs_bmc *kcs_bmc = to_kcs_bmc(filp);
272 poll_wait(filp, &kcs_bmc->queue, wait);
274 spin_lock_irq(&kcs_bmc->lock);
275 if (kcs_bmc->data_in_avail)
277 spin_unlock_irq(&kcs_bmc->lock);
282 static ssize_t kcs_bmc_read(struct file *filp, char __user *buf,
283 size_t count, loff_t *ppos)
285 struct kcs_bmc *kcs_bmc = to_kcs_bmc(filp);
290 if (!(filp->f_flags & O_NONBLOCK))
291 wait_event_interruptible(kcs_bmc->queue,
292 kcs_bmc->data_in_avail);
294 mutex_lock(&kcs_bmc->mutex);
296 spin_lock_irq(&kcs_bmc->lock);
297 data_avail = kcs_bmc->data_in_avail;
299 data_len = kcs_bmc->data_in_idx;
300 memcpy(kcs_bmc->kbuffer, kcs_bmc->data_in, data_len);
302 spin_unlock_irq(&kcs_bmc->lock);
309 if (count < data_len) {
310 pr_err("channel=%u with too large data : %zu\n",
311 kcs_bmc->channel, data_len);
313 spin_lock_irq(&kcs_bmc->lock);
314 kcs_force_abort(kcs_bmc);
315 spin_unlock_irq(&kcs_bmc->lock);
321 if (copy_to_user(buf, kcs_bmc->kbuffer, data_len)) {
328 spin_lock_irq(&kcs_bmc->lock);
329 if (kcs_bmc->phase == KCS_PHASE_WRITE_DONE) {
330 kcs_bmc->phase = KCS_PHASE_WAIT_READ;
331 kcs_bmc->data_in_avail = false;
332 kcs_bmc->data_in_idx = 0;
336 spin_unlock_irq(&kcs_bmc->lock);
339 mutex_unlock(&kcs_bmc->mutex);
344 static ssize_t kcs_bmc_write(struct file *filp, const char __user *buf,
345 size_t count, loff_t *ppos)
347 struct kcs_bmc *kcs_bmc = to_kcs_bmc(filp);
350 /* a minimum response size '3' : netfn + cmd + ccode */
351 if (count < 3 || count > KCS_MSG_BUFSIZ)
354 mutex_lock(&kcs_bmc->mutex);
356 if (copy_from_user(kcs_bmc->kbuffer, buf, count)) {
361 spin_lock_irq(&kcs_bmc->lock);
362 if (kcs_bmc->phase == KCS_PHASE_WAIT_READ) {
363 kcs_bmc->phase = KCS_PHASE_READ;
364 kcs_bmc->data_out_idx = 1;
365 kcs_bmc->data_out_len = count;
366 memcpy(kcs_bmc->data_out, kcs_bmc->kbuffer, count);
367 write_data(kcs_bmc, kcs_bmc->data_out[0]);
372 spin_unlock_irq(&kcs_bmc->lock);
375 mutex_unlock(&kcs_bmc->mutex);
380 static long kcs_bmc_ioctl(struct file *filp, unsigned int cmd,
383 struct kcs_bmc *kcs_bmc = to_kcs_bmc(filp);
386 spin_lock_irq(&kcs_bmc->lock);
389 case IPMI_BMC_IOCTL_SET_SMS_ATN:
390 update_status_bits(kcs_bmc, KCS_STATUS_SMS_ATN,
394 case IPMI_BMC_IOCTL_CLEAR_SMS_ATN:
395 update_status_bits(kcs_bmc, KCS_STATUS_SMS_ATN,
399 case IPMI_BMC_IOCTL_FORCE_ABORT:
400 kcs_force_abort(kcs_bmc);
408 spin_unlock_irq(&kcs_bmc->lock);
413 static int kcs_bmc_release(struct inode *inode, struct file *filp)
415 struct kcs_bmc *kcs_bmc = to_kcs_bmc(filp);
417 spin_lock_irq(&kcs_bmc->lock);
418 kcs_bmc->running = 0;
419 kcs_force_abort(kcs_bmc);
420 spin_unlock_irq(&kcs_bmc->lock);
425 static const struct file_operations kcs_bmc_fops = {
426 .owner = THIS_MODULE,
427 .open = kcs_bmc_open,
428 .read = kcs_bmc_read,
429 .write = kcs_bmc_write,
430 .release = kcs_bmc_release,
431 .poll = kcs_bmc_poll,
432 .unlocked_ioctl = kcs_bmc_ioctl,
435 struct kcs_bmc *kcs_bmc_alloc(struct device *dev, int sizeof_priv, u32 channel)
437 struct kcs_bmc *kcs_bmc;
439 kcs_bmc = devm_kzalloc(dev, sizeof(*kcs_bmc) + sizeof_priv, GFP_KERNEL);
443 dev_set_name(dev, "ipmi-kcs%u", channel);
445 spin_lock_init(&kcs_bmc->lock);
446 kcs_bmc->channel = channel;
448 mutex_init(&kcs_bmc->mutex);
449 init_waitqueue_head(&kcs_bmc->queue);
451 kcs_bmc->data_in = devm_kmalloc(dev, KCS_MSG_BUFSIZ, GFP_KERNEL);
452 kcs_bmc->data_out = devm_kmalloc(dev, KCS_MSG_BUFSIZ, GFP_KERNEL);
453 kcs_bmc->kbuffer = devm_kmalloc(dev, KCS_MSG_BUFSIZ, GFP_KERNEL);
454 if (!kcs_bmc->data_in || !kcs_bmc->data_out || !kcs_bmc->kbuffer)
457 kcs_bmc->miscdev.minor = MISC_DYNAMIC_MINOR;
458 kcs_bmc->miscdev.name = dev_name(dev);
459 kcs_bmc->miscdev.fops = &kcs_bmc_fops;
463 EXPORT_SYMBOL(kcs_bmc_alloc);
465 MODULE_LICENSE("GPL v2");
466 MODULE_AUTHOR("Haiyue Wang <haiyue.wang@linux.intel.com>");
467 MODULE_DESCRIPTION("KCS BMC to handle the IPMI request from system software");