Loading...
1/*
2 * Driver for the HP iLO management processor.
3 *
4 * Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
5 * David Altobelli <david.altobelli@hpe.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 */
11#include <linux/kernel.h>
12#include <linux/types.h>
13#include <linux/module.h>
14#include <linux/fs.h>
15#include <linux/pci.h>
16#include <linux/interrupt.h>
17#include <linux/ioport.h>
18#include <linux/device.h>
19#include <linux/file.h>
20#include <linux/cdev.h>
21#include <linux/sched.h>
22#include <linux/spinlock.h>
23#include <linux/delay.h>
24#include <linux/uaccess.h>
25#include <linux/io.h>
26#include <linux/wait.h>
27#include <linux/poll.h>
28#include <linux/slab.h>
29#include "hpilo.h"
30
31static struct class *ilo_class;
32static unsigned int ilo_major;
33static unsigned int max_ccb = 16;
34static char ilo_hwdev[MAX_ILO_DEV];
35
36static inline int get_entry_id(int entry)
37{
38 return (entry & ENTRY_MASK_DESCRIPTOR) >> ENTRY_BITPOS_DESCRIPTOR;
39}
40
41static inline int get_entry_len(int entry)
42{
43 return ((entry & ENTRY_MASK_QWORDS) >> ENTRY_BITPOS_QWORDS) << 3;
44}
45
46static inline int mk_entry(int id, int len)
47{
48 int qlen = len & 7 ? (len >> 3) + 1 : len >> 3;
49 return id << ENTRY_BITPOS_DESCRIPTOR | qlen << ENTRY_BITPOS_QWORDS;
50}
51
52static inline int desc_mem_sz(int nr_entry)
53{
54 return nr_entry << L2_QENTRY_SZ;
55}
56
57/*
58 * FIFO queues, shared with hardware.
59 *
60 * If a queue has empty slots, an entry is added to the queue tail,
61 * and that entry is marked as occupied.
62 * Entries can be dequeued from the head of the list, when the device
63 * has marked the entry as consumed.
64 *
65 * Returns true on successful queue/dequeue, false on failure.
66 */
67static int fifo_enqueue(struct ilo_hwinfo *hw, char *fifobar, int entry)
68{
69 struct fifo *fifo_q = FIFOBARTOHANDLE(fifobar);
70 unsigned long flags;
71 int ret = 0;
72
73 spin_lock_irqsave(&hw->fifo_lock, flags);
74 if (!(fifo_q->fifobar[(fifo_q->tail + 1) & fifo_q->imask]
75 & ENTRY_MASK_O)) {
76 fifo_q->fifobar[fifo_q->tail & fifo_q->imask] |=
77 (entry & ENTRY_MASK_NOSTATE) | fifo_q->merge;
78 fifo_q->tail += 1;
79 ret = 1;
80 }
81 spin_unlock_irqrestore(&hw->fifo_lock, flags);
82
83 return ret;
84}
85
86static int fifo_dequeue(struct ilo_hwinfo *hw, char *fifobar, int *entry)
87{
88 struct fifo *fifo_q = FIFOBARTOHANDLE(fifobar);
89 unsigned long flags;
90 int ret = 0;
91 u64 c;
92
93 spin_lock_irqsave(&hw->fifo_lock, flags);
94 c = fifo_q->fifobar[fifo_q->head & fifo_q->imask];
95 if (c & ENTRY_MASK_C) {
96 if (entry)
97 *entry = c & ENTRY_MASK_NOSTATE;
98
99 fifo_q->fifobar[fifo_q->head & fifo_q->imask] =
100 (c | ENTRY_MASK) + 1;
101 fifo_q->head += 1;
102 ret = 1;
103 }
104 spin_unlock_irqrestore(&hw->fifo_lock, flags);
105
106 return ret;
107}
108
109static int fifo_check_recv(struct ilo_hwinfo *hw, char *fifobar)
110{
111 struct fifo *fifo_q = FIFOBARTOHANDLE(fifobar);
112 unsigned long flags;
113 int ret = 0;
114 u64 c;
115
116 spin_lock_irqsave(&hw->fifo_lock, flags);
117 c = fifo_q->fifobar[fifo_q->head & fifo_q->imask];
118 if (c & ENTRY_MASK_C)
119 ret = 1;
120 spin_unlock_irqrestore(&hw->fifo_lock, flags);
121
122 return ret;
123}
124
125static int ilo_pkt_enqueue(struct ilo_hwinfo *hw, struct ccb *ccb,
126 int dir, int id, int len)
127{
128 char *fifobar;
129 int entry;
130
131 if (dir == SENDQ)
132 fifobar = ccb->ccb_u1.send_fifobar;
133 else
134 fifobar = ccb->ccb_u3.recv_fifobar;
135
136 entry = mk_entry(id, len);
137 return fifo_enqueue(hw, fifobar, entry);
138}
139
140static int ilo_pkt_dequeue(struct ilo_hwinfo *hw, struct ccb *ccb,
141 int dir, int *id, int *len, void **pkt)
142{
143 char *fifobar, *desc;
144 int entry = 0, pkt_id = 0;
145 int ret;
146
147 if (dir == SENDQ) {
148 fifobar = ccb->ccb_u1.send_fifobar;
149 desc = ccb->ccb_u2.send_desc;
150 } else {
151 fifobar = ccb->ccb_u3.recv_fifobar;
152 desc = ccb->ccb_u4.recv_desc;
153 }
154
155 ret = fifo_dequeue(hw, fifobar, &entry);
156 if (ret) {
157 pkt_id = get_entry_id(entry);
158 if (id)
159 *id = pkt_id;
160 if (len)
161 *len = get_entry_len(entry);
162 if (pkt)
163 *pkt = (void *)(desc + desc_mem_sz(pkt_id));
164 }
165
166 return ret;
167}
168
169static int ilo_pkt_recv(struct ilo_hwinfo *hw, struct ccb *ccb)
170{
171 char *fifobar = ccb->ccb_u3.recv_fifobar;
172
173 return fifo_check_recv(hw, fifobar);
174}
175
176static inline void doorbell_set(struct ccb *ccb)
177{
178 iowrite8(1, ccb->ccb_u5.db_base);
179}
180
181static inline void doorbell_clr(struct ccb *ccb)
182{
183 iowrite8(2, ccb->ccb_u5.db_base);
184}
185
186static inline int ctrl_set(int l2sz, int idxmask, int desclim)
187{
188 int active = 0, go = 1;
189 return l2sz << CTRL_BITPOS_L2SZ |
190 idxmask << CTRL_BITPOS_FIFOINDEXMASK |
191 desclim << CTRL_BITPOS_DESCLIMIT |
192 active << CTRL_BITPOS_A |
193 go << CTRL_BITPOS_G;
194}
195
196static void ctrl_setup(struct ccb *ccb, int nr_desc, int l2desc_sz)
197{
198 /* for simplicity, use the same parameters for send and recv ctrls */
199 ccb->send_ctrl = ctrl_set(l2desc_sz, nr_desc-1, nr_desc-1);
200 ccb->recv_ctrl = ctrl_set(l2desc_sz, nr_desc-1, nr_desc-1);
201}
202
203static inline int fifo_sz(int nr_entry)
204{
205 /* size of a fifo is determined by the number of entries it contains */
206 return (nr_entry * sizeof(u64)) + FIFOHANDLESIZE;
207}
208
209static void fifo_setup(void *base_addr, int nr_entry)
210{
211 struct fifo *fifo_q = base_addr;
212 int i;
213
214 /* set up an empty fifo */
215 fifo_q->head = 0;
216 fifo_q->tail = 0;
217 fifo_q->reset = 0;
218 fifo_q->nrents = nr_entry;
219 fifo_q->imask = nr_entry - 1;
220 fifo_q->merge = ENTRY_MASK_O;
221
222 for (i = 0; i < nr_entry; i++)
223 fifo_q->fifobar[i] = 0;
224}
225
226static void ilo_ccb_close(struct pci_dev *pdev, struct ccb_data *data)
227{
228 struct ccb *driver_ccb = &data->driver_ccb;
229 struct ccb __iomem *device_ccb = data->mapped_ccb;
230 int retries;
231
232 /* complicated dance to tell the hw we are stopping */
233 doorbell_clr(driver_ccb);
234 iowrite32(ioread32(&device_ccb->send_ctrl) & ~(1 << CTRL_BITPOS_G),
235 &device_ccb->send_ctrl);
236 iowrite32(ioread32(&device_ccb->recv_ctrl) & ~(1 << CTRL_BITPOS_G),
237 &device_ccb->recv_ctrl);
238
239 /* give iLO some time to process stop request */
240 for (retries = MAX_WAIT; retries > 0; retries--) {
241 doorbell_set(driver_ccb);
242 udelay(WAIT_TIME);
243 if (!(ioread32(&device_ccb->send_ctrl) & (1 << CTRL_BITPOS_A))
244 &&
245 !(ioread32(&device_ccb->recv_ctrl) & (1 << CTRL_BITPOS_A)))
246 break;
247 }
248 if (retries == 0)
249 dev_err(&pdev->dev, "Closing, but controller still active\n");
250
251 /* clear the hw ccb */
252 memset_io(device_ccb, 0, sizeof(struct ccb));
253
254 /* free resources used to back send/recv queues */
255 pci_free_consistent(pdev, data->dma_size, data->dma_va, data->dma_pa);
256}
257
258static int ilo_ccb_setup(struct ilo_hwinfo *hw, struct ccb_data *data, int slot)
259{
260 char *dma_va;
261 dma_addr_t dma_pa;
262 struct ccb *driver_ccb, *ilo_ccb;
263
264 driver_ccb = &data->driver_ccb;
265 ilo_ccb = &data->ilo_ccb;
266
267 data->dma_size = 2 * fifo_sz(NR_QENTRY) +
268 2 * desc_mem_sz(NR_QENTRY) +
269 ILO_START_ALIGN + ILO_CACHE_SZ;
270
271 data->dma_va = pci_alloc_consistent(hw->ilo_dev, data->dma_size,
272 &data->dma_pa);
273 if (!data->dma_va)
274 return -ENOMEM;
275
276 dma_va = (char *)data->dma_va;
277 dma_pa = data->dma_pa;
278
279 memset(dma_va, 0, data->dma_size);
280
281 dma_va = (char *)roundup((unsigned long)dma_va, ILO_START_ALIGN);
282 dma_pa = roundup(dma_pa, ILO_START_ALIGN);
283
284 /*
285 * Create two ccb's, one with virt addrs, one with phys addrs.
286 * Copy the phys addr ccb to device shared mem.
287 */
288 ctrl_setup(driver_ccb, NR_QENTRY, L2_QENTRY_SZ);
289 ctrl_setup(ilo_ccb, NR_QENTRY, L2_QENTRY_SZ);
290
291 fifo_setup(dma_va, NR_QENTRY);
292 driver_ccb->ccb_u1.send_fifobar = dma_va + FIFOHANDLESIZE;
293 ilo_ccb->ccb_u1.send_fifobar_pa = dma_pa + FIFOHANDLESIZE;
294 dma_va += fifo_sz(NR_QENTRY);
295 dma_pa += fifo_sz(NR_QENTRY);
296
297 dma_va = (char *)roundup((unsigned long)dma_va, ILO_CACHE_SZ);
298 dma_pa = roundup(dma_pa, ILO_CACHE_SZ);
299
300 fifo_setup(dma_va, NR_QENTRY);
301 driver_ccb->ccb_u3.recv_fifobar = dma_va + FIFOHANDLESIZE;
302 ilo_ccb->ccb_u3.recv_fifobar_pa = dma_pa + FIFOHANDLESIZE;
303 dma_va += fifo_sz(NR_QENTRY);
304 dma_pa += fifo_sz(NR_QENTRY);
305
306 driver_ccb->ccb_u2.send_desc = dma_va;
307 ilo_ccb->ccb_u2.send_desc_pa = dma_pa;
308 dma_pa += desc_mem_sz(NR_QENTRY);
309 dma_va += desc_mem_sz(NR_QENTRY);
310
311 driver_ccb->ccb_u4.recv_desc = dma_va;
312 ilo_ccb->ccb_u4.recv_desc_pa = dma_pa;
313
314 driver_ccb->channel = slot;
315 ilo_ccb->channel = slot;
316
317 driver_ccb->ccb_u5.db_base = hw->db_vaddr + (slot << L2_DB_SIZE);
318 ilo_ccb->ccb_u5.db_base = NULL; /* hw ccb's doorbell is not used */
319
320 return 0;
321}
322
323static void ilo_ccb_open(struct ilo_hwinfo *hw, struct ccb_data *data, int slot)
324{
325 int pkt_id, pkt_sz;
326 struct ccb *driver_ccb = &data->driver_ccb;
327
328 /* copy the ccb with physical addrs to device memory */
329 data->mapped_ccb = (struct ccb __iomem *)
330 (hw->ram_vaddr + (slot * ILOHW_CCB_SZ));
331 memcpy_toio(data->mapped_ccb, &data->ilo_ccb, sizeof(struct ccb));
332
333 /* put packets on the send and receive queues */
334 pkt_sz = 0;
335 for (pkt_id = 0; pkt_id < NR_QENTRY; pkt_id++) {
336 ilo_pkt_enqueue(hw, driver_ccb, SENDQ, pkt_id, pkt_sz);
337 doorbell_set(driver_ccb);
338 }
339
340 pkt_sz = desc_mem_sz(1);
341 for (pkt_id = 0; pkt_id < NR_QENTRY; pkt_id++)
342 ilo_pkt_enqueue(hw, driver_ccb, RECVQ, pkt_id, pkt_sz);
343
344 /* the ccb is ready to use */
345 doorbell_clr(driver_ccb);
346}
347
348static int ilo_ccb_verify(struct ilo_hwinfo *hw, struct ccb_data *data)
349{
350 int pkt_id, i;
351 struct ccb *driver_ccb = &data->driver_ccb;
352
353 /* make sure iLO is really handling requests */
354 for (i = MAX_WAIT; i > 0; i--) {
355 if (ilo_pkt_dequeue(hw, driver_ccb, SENDQ, &pkt_id, NULL, NULL))
356 break;
357 udelay(WAIT_TIME);
358 }
359
360 if (i == 0) {
361 dev_err(&hw->ilo_dev->dev, "Open could not dequeue a packet\n");
362 return -EBUSY;
363 }
364
365 ilo_pkt_enqueue(hw, driver_ccb, SENDQ, pkt_id, 0);
366 doorbell_set(driver_ccb);
367 return 0;
368}
369
370static inline int is_channel_reset(struct ccb *ccb)
371{
372 /* check for this particular channel needing a reset */
373 return FIFOBARTOHANDLE(ccb->ccb_u1.send_fifobar)->reset;
374}
375
376static inline void set_channel_reset(struct ccb *ccb)
377{
378 /* set a flag indicating this channel needs a reset */
379 FIFOBARTOHANDLE(ccb->ccb_u1.send_fifobar)->reset = 1;
380}
381
382static inline int get_device_outbound(struct ilo_hwinfo *hw)
383{
384 return ioread32(&hw->mmio_vaddr[DB_OUT]);
385}
386
387static inline int is_db_reset(int db_out)
388{
389 return db_out & (1 << DB_RESET);
390}
391
392static inline int is_device_reset(struct ilo_hwinfo *hw)
393{
394 /* check for global reset condition */
395 return is_db_reset(get_device_outbound(hw));
396}
397
398static inline void clear_pending_db(struct ilo_hwinfo *hw, int clr)
399{
400 iowrite32(clr, &hw->mmio_vaddr[DB_OUT]);
401}
402
403static inline void clear_device(struct ilo_hwinfo *hw)
404{
405 /* clear the device (reset bits, pending channel entries) */
406 clear_pending_db(hw, -1);
407}
408
409static inline void ilo_enable_interrupts(struct ilo_hwinfo *hw)
410{
411 iowrite8(ioread8(&hw->mmio_vaddr[DB_IRQ]) | 1, &hw->mmio_vaddr[DB_IRQ]);
412}
413
414static inline void ilo_disable_interrupts(struct ilo_hwinfo *hw)
415{
416 iowrite8(ioread8(&hw->mmio_vaddr[DB_IRQ]) & ~1,
417 &hw->mmio_vaddr[DB_IRQ]);
418}
419
420static void ilo_set_reset(struct ilo_hwinfo *hw)
421{
422 int slot;
423
424 /*
425 * Mapped memory is zeroed on ilo reset, so set a per ccb flag
426 * to indicate that this ccb needs to be closed and reopened.
427 */
428 for (slot = 0; slot < max_ccb; slot++) {
429 if (!hw->ccb_alloc[slot])
430 continue;
431 set_channel_reset(&hw->ccb_alloc[slot]->driver_ccb);
432 }
433}
434
435static ssize_t ilo_read(struct file *fp, char __user *buf,
436 size_t len, loff_t *off)
437{
438 int err, found, cnt, pkt_id, pkt_len;
439 struct ccb_data *data = fp->private_data;
440 struct ccb *driver_ccb = &data->driver_ccb;
441 struct ilo_hwinfo *hw = data->ilo_hw;
442 void *pkt;
443
444 if (is_channel_reset(driver_ccb)) {
445 /*
446 * If the device has been reset, applications
447 * need to close and reopen all ccbs.
448 */
449 return -ENODEV;
450 }
451
452 /*
453 * This function is to be called when data is expected
454 * in the channel, and will return an error if no packet is found
455 * during the loop below. The sleep/retry logic is to allow
456 * applications to call read() immediately post write(),
457 * and give iLO some time to process the sent packet.
458 */
459 cnt = 20;
460 do {
461 /* look for a received packet */
462 found = ilo_pkt_dequeue(hw, driver_ccb, RECVQ, &pkt_id,
463 &pkt_len, &pkt);
464 if (found)
465 break;
466 cnt--;
467 msleep(100);
468 } while (!found && cnt);
469
470 if (!found)
471 return -EAGAIN;
472
473 /* only copy the length of the received packet */
474 if (pkt_len < len)
475 len = pkt_len;
476
477 err = copy_to_user(buf, pkt, len);
478
479 /* return the received packet to the queue */
480 ilo_pkt_enqueue(hw, driver_ccb, RECVQ, pkt_id, desc_mem_sz(1));
481
482 return err ? -EFAULT : len;
483}
484
485static ssize_t ilo_write(struct file *fp, const char __user *buf,
486 size_t len, loff_t *off)
487{
488 int err, pkt_id, pkt_len;
489 struct ccb_data *data = fp->private_data;
490 struct ccb *driver_ccb = &data->driver_ccb;
491 struct ilo_hwinfo *hw = data->ilo_hw;
492 void *pkt;
493
494 if (is_channel_reset(driver_ccb))
495 return -ENODEV;
496
497 /* get a packet to send the user command */
498 if (!ilo_pkt_dequeue(hw, driver_ccb, SENDQ, &pkt_id, &pkt_len, &pkt))
499 return -EBUSY;
500
501 /* limit the length to the length of the packet */
502 if (pkt_len < len)
503 len = pkt_len;
504
505 /* on failure, set the len to 0 to return empty packet to the device */
506 err = copy_from_user(pkt, buf, len);
507 if (err)
508 len = 0;
509
510 /* send the packet */
511 ilo_pkt_enqueue(hw, driver_ccb, SENDQ, pkt_id, len);
512 doorbell_set(driver_ccb);
513
514 return err ? -EFAULT : len;
515}
516
517static unsigned int ilo_poll(struct file *fp, poll_table *wait)
518{
519 struct ccb_data *data = fp->private_data;
520 struct ccb *driver_ccb = &data->driver_ccb;
521
522 poll_wait(fp, &data->ccb_waitq, wait);
523
524 if (is_channel_reset(driver_ccb))
525 return POLLERR;
526 else if (ilo_pkt_recv(data->ilo_hw, driver_ccb))
527 return POLLIN | POLLRDNORM;
528
529 return 0;
530}
531
532static int ilo_close(struct inode *ip, struct file *fp)
533{
534 int slot;
535 struct ccb_data *data;
536 struct ilo_hwinfo *hw;
537 unsigned long flags;
538
539 slot = iminor(ip) % max_ccb;
540 hw = container_of(ip->i_cdev, struct ilo_hwinfo, cdev);
541
542 spin_lock(&hw->open_lock);
543
544 if (hw->ccb_alloc[slot]->ccb_cnt == 1) {
545
546 data = fp->private_data;
547
548 spin_lock_irqsave(&hw->alloc_lock, flags);
549 hw->ccb_alloc[slot] = NULL;
550 spin_unlock_irqrestore(&hw->alloc_lock, flags);
551
552 ilo_ccb_close(hw->ilo_dev, data);
553
554 kfree(data);
555 } else
556 hw->ccb_alloc[slot]->ccb_cnt--;
557
558 spin_unlock(&hw->open_lock);
559
560 return 0;
561}
562
563static int ilo_open(struct inode *ip, struct file *fp)
564{
565 int slot, error;
566 struct ccb_data *data;
567 struct ilo_hwinfo *hw;
568 unsigned long flags;
569
570 slot = iminor(ip) % max_ccb;
571 hw = container_of(ip->i_cdev, struct ilo_hwinfo, cdev);
572
573 /* new ccb allocation */
574 data = kzalloc(sizeof(*data), GFP_KERNEL);
575 if (!data)
576 return -ENOMEM;
577
578 spin_lock(&hw->open_lock);
579
580 /* each fd private_data holds sw/hw view of ccb */
581 if (hw->ccb_alloc[slot] == NULL) {
582 /* create a channel control block for this minor */
583 error = ilo_ccb_setup(hw, data, slot);
584 if (error) {
585 kfree(data);
586 goto out;
587 }
588
589 data->ccb_cnt = 1;
590 data->ccb_excl = fp->f_flags & O_EXCL;
591 data->ilo_hw = hw;
592 init_waitqueue_head(&data->ccb_waitq);
593
594 /* write the ccb to hw */
595 spin_lock_irqsave(&hw->alloc_lock, flags);
596 ilo_ccb_open(hw, data, slot);
597 hw->ccb_alloc[slot] = data;
598 spin_unlock_irqrestore(&hw->alloc_lock, flags);
599
600 /* make sure the channel is functional */
601 error = ilo_ccb_verify(hw, data);
602 if (error) {
603
604 spin_lock_irqsave(&hw->alloc_lock, flags);
605 hw->ccb_alloc[slot] = NULL;
606 spin_unlock_irqrestore(&hw->alloc_lock, flags);
607
608 ilo_ccb_close(hw->ilo_dev, data);
609
610 kfree(data);
611 goto out;
612 }
613
614 } else {
615 kfree(data);
616 if (fp->f_flags & O_EXCL || hw->ccb_alloc[slot]->ccb_excl) {
617 /*
618 * The channel exists, and either this open
619 * or a previous open of this channel wants
620 * exclusive access.
621 */
622 error = -EBUSY;
623 } else {
624 hw->ccb_alloc[slot]->ccb_cnt++;
625 error = 0;
626 }
627 }
628out:
629 spin_unlock(&hw->open_lock);
630
631 if (!error)
632 fp->private_data = hw->ccb_alloc[slot];
633
634 return error;
635}
636
637static const struct file_operations ilo_fops = {
638 .owner = THIS_MODULE,
639 .read = ilo_read,
640 .write = ilo_write,
641 .poll = ilo_poll,
642 .open = ilo_open,
643 .release = ilo_close,
644 .llseek = noop_llseek,
645};
646
647static irqreturn_t ilo_isr(int irq, void *data)
648{
649 struct ilo_hwinfo *hw = data;
650 int pending, i;
651
652 spin_lock(&hw->alloc_lock);
653
654 /* check for ccbs which have data */
655 pending = get_device_outbound(hw);
656 if (!pending) {
657 spin_unlock(&hw->alloc_lock);
658 return IRQ_NONE;
659 }
660
661 if (is_db_reset(pending)) {
662 /* wake up all ccbs if the device was reset */
663 pending = -1;
664 ilo_set_reset(hw);
665 }
666
667 for (i = 0; i < max_ccb; i++) {
668 if (!hw->ccb_alloc[i])
669 continue;
670 if (pending & (1 << i))
671 wake_up_interruptible(&hw->ccb_alloc[i]->ccb_waitq);
672 }
673
674 /* clear the device of the channels that have been handled */
675 clear_pending_db(hw, pending);
676
677 spin_unlock(&hw->alloc_lock);
678
679 return IRQ_HANDLED;
680}
681
682static void ilo_unmap_device(struct pci_dev *pdev, struct ilo_hwinfo *hw)
683{
684 pci_iounmap(pdev, hw->db_vaddr);
685 pci_iounmap(pdev, hw->ram_vaddr);
686 pci_iounmap(pdev, hw->mmio_vaddr);
687}
688
689static int ilo_map_device(struct pci_dev *pdev, struct ilo_hwinfo *hw)
690{
691 int error = -ENOMEM;
692
693 /* map the memory mapped i/o registers */
694 hw->mmio_vaddr = pci_iomap(pdev, 1, 0);
695 if (hw->mmio_vaddr == NULL) {
696 dev_err(&pdev->dev, "Error mapping mmio\n");
697 goto out;
698 }
699
700 /* map the adapter shared memory region */
701 hw->ram_vaddr = pci_iomap(pdev, 2, max_ccb * ILOHW_CCB_SZ);
702 if (hw->ram_vaddr == NULL) {
703 dev_err(&pdev->dev, "Error mapping shared mem\n");
704 goto mmio_free;
705 }
706
707 /* map the doorbell aperture */
708 hw->db_vaddr = pci_iomap(pdev, 3, max_ccb * ONE_DB_SIZE);
709 if (hw->db_vaddr == NULL) {
710 dev_err(&pdev->dev, "Error mapping doorbell\n");
711 goto ram_free;
712 }
713
714 return 0;
715ram_free:
716 pci_iounmap(pdev, hw->ram_vaddr);
717mmio_free:
718 pci_iounmap(pdev, hw->mmio_vaddr);
719out:
720 return error;
721}
722
723static void ilo_remove(struct pci_dev *pdev)
724{
725 int i, minor;
726 struct ilo_hwinfo *ilo_hw = pci_get_drvdata(pdev);
727
728 if (!ilo_hw)
729 return;
730
731 clear_device(ilo_hw);
732
733 minor = MINOR(ilo_hw->cdev.dev);
734 for (i = minor; i < minor + max_ccb; i++)
735 device_destroy(ilo_class, MKDEV(ilo_major, i));
736
737 cdev_del(&ilo_hw->cdev);
738 ilo_disable_interrupts(ilo_hw);
739 free_irq(pdev->irq, ilo_hw);
740 ilo_unmap_device(pdev, ilo_hw);
741 pci_release_regions(pdev);
742 /*
743 * pci_disable_device(pdev) used to be here. But this PCI device has
744 * two functions with interrupt lines connected to a single pin. The
745 * other one is a USB host controller. So when we disable the PIN here
746 * e.g. by rmmod hpilo, the controller stops working. It is because
747 * the interrupt link is disabled in ACPI since it is not refcounted
748 * yet. See acpi_pci_link_free_irq called from acpi_pci_irq_disable.
749 */
750 kfree(ilo_hw);
751 ilo_hwdev[(minor / max_ccb)] = 0;
752}
753
754static int ilo_probe(struct pci_dev *pdev,
755 const struct pci_device_id *ent)
756{
757 int devnum, minor, start, error = 0;
758 struct ilo_hwinfo *ilo_hw;
759
760 /* Ignore subsystem_device = 0x1979 (set by BIOS) */
761 if (pdev->subsystem_device == 0x1979)
762 return 0;
763
764 if (max_ccb > MAX_CCB)
765 max_ccb = MAX_CCB;
766 else if (max_ccb < MIN_CCB)
767 max_ccb = MIN_CCB;
768
769 /* find a free range for device files */
770 for (devnum = 0; devnum < MAX_ILO_DEV; devnum++) {
771 if (ilo_hwdev[devnum] == 0) {
772 ilo_hwdev[devnum] = 1;
773 break;
774 }
775 }
776
777 if (devnum == MAX_ILO_DEV) {
778 dev_err(&pdev->dev, "Error finding free device\n");
779 return -ENODEV;
780 }
781
782 /* track global allocations for this device */
783 error = -ENOMEM;
784 ilo_hw = kzalloc(sizeof(*ilo_hw), GFP_KERNEL);
785 if (!ilo_hw)
786 goto out;
787
788 ilo_hw->ilo_dev = pdev;
789 spin_lock_init(&ilo_hw->alloc_lock);
790 spin_lock_init(&ilo_hw->fifo_lock);
791 spin_lock_init(&ilo_hw->open_lock);
792
793 error = pci_enable_device(pdev);
794 if (error)
795 goto free;
796
797 pci_set_master(pdev);
798
799 error = pci_request_regions(pdev, ILO_NAME);
800 if (error)
801 goto disable;
802
803 error = ilo_map_device(pdev, ilo_hw);
804 if (error)
805 goto free_regions;
806
807 pci_set_drvdata(pdev, ilo_hw);
808 clear_device(ilo_hw);
809
810 error = request_irq(pdev->irq, ilo_isr, IRQF_SHARED, "hpilo", ilo_hw);
811 if (error)
812 goto unmap;
813
814 ilo_enable_interrupts(ilo_hw);
815
816 cdev_init(&ilo_hw->cdev, &ilo_fops);
817 ilo_hw->cdev.owner = THIS_MODULE;
818 start = devnum * max_ccb;
819 error = cdev_add(&ilo_hw->cdev, MKDEV(ilo_major, start), max_ccb);
820 if (error) {
821 dev_err(&pdev->dev, "Could not add cdev\n");
822 goto remove_isr;
823 }
824
825 for (minor = 0 ; minor < max_ccb; minor++) {
826 struct device *dev;
827 dev = device_create(ilo_class, &pdev->dev,
828 MKDEV(ilo_major, minor), NULL,
829 "hpilo!d%dccb%d", devnum, minor);
830 if (IS_ERR(dev))
831 dev_err(&pdev->dev, "Could not create files\n");
832 }
833
834 return 0;
835remove_isr:
836 ilo_disable_interrupts(ilo_hw);
837 free_irq(pdev->irq, ilo_hw);
838unmap:
839 ilo_unmap_device(pdev, ilo_hw);
840free_regions:
841 pci_release_regions(pdev);
842disable:
843/* pci_disable_device(pdev); see comment in ilo_remove */
844free:
845 kfree(ilo_hw);
846out:
847 ilo_hwdev[devnum] = 0;
848 return error;
849}
850
851static struct pci_device_id ilo_devices[] = {
852 { PCI_DEVICE(PCI_VENDOR_ID_COMPAQ, 0xB204) },
853 { PCI_DEVICE(PCI_VENDOR_ID_HP, 0x3307) },
854 { }
855};
856MODULE_DEVICE_TABLE(pci, ilo_devices);
857
858static struct pci_driver ilo_driver = {
859 .name = ILO_NAME,
860 .id_table = ilo_devices,
861 .probe = ilo_probe,
862 .remove = ilo_remove,
863};
864
865static int __init ilo_init(void)
866{
867 int error;
868 dev_t dev;
869
870 ilo_class = class_create(THIS_MODULE, "iLO");
871 if (IS_ERR(ilo_class)) {
872 error = PTR_ERR(ilo_class);
873 goto out;
874 }
875
876 error = alloc_chrdev_region(&dev, 0, MAX_OPEN, ILO_NAME);
877 if (error)
878 goto class_destroy;
879
880 ilo_major = MAJOR(dev);
881
882 error = pci_register_driver(&ilo_driver);
883 if (error)
884 goto chr_remove;
885
886 return 0;
887chr_remove:
888 unregister_chrdev_region(dev, MAX_OPEN);
889class_destroy:
890 class_destroy(ilo_class);
891out:
892 return error;
893}
894
895static void __exit ilo_exit(void)
896{
897 pci_unregister_driver(&ilo_driver);
898 unregister_chrdev_region(MKDEV(ilo_major, 0), MAX_OPEN);
899 class_destroy(ilo_class);
900}
901
902MODULE_VERSION("1.4.1");
903MODULE_ALIAS(ILO_NAME);
904MODULE_DESCRIPTION(ILO_NAME);
905MODULE_AUTHOR("David Altobelli <david.altobelli@hpe.com>");
906MODULE_LICENSE("GPL v2");
907
908module_param(max_ccb, uint, 0444);
909MODULE_PARM_DESC(max_ccb, "Maximum number of HP iLO channels to attach (8-24)(default=16)");
910
911module_init(ilo_init);
912module_exit(ilo_exit);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Driver for the HP iLO management processor.
4 *
5 * Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
6 * David Altobelli <david.altobelli@hpe.com>
7 */
8#include <linux/kernel.h>
9#include <linux/types.h>
10#include <linux/module.h>
11#include <linux/fs.h>
12#include <linux/pci.h>
13#include <linux/interrupt.h>
14#include <linux/ioport.h>
15#include <linux/device.h>
16#include <linux/file.h>
17#include <linux/cdev.h>
18#include <linux/sched.h>
19#include <linux/spinlock.h>
20#include <linux/delay.h>
21#include <linux/uaccess.h>
22#include <linux/io.h>
23#include <linux/wait.h>
24#include <linux/poll.h>
25#include <linux/slab.h>
26#include "hpilo.h"
27
28static struct class *ilo_class;
29static unsigned int ilo_major;
30static unsigned int max_ccb = 16;
31static char ilo_hwdev[MAX_ILO_DEV];
32static const struct pci_device_id ilo_blacklist[] = {
33 /* auxiliary iLO */
34 {PCI_DEVICE_SUB(PCI_VENDOR_ID_HP, 0x3307, PCI_VENDOR_ID_HP, 0x1979)},
35 /* CL */
36 {PCI_DEVICE_SUB(PCI_VENDOR_ID_HP, 0x3307, PCI_VENDOR_ID_HP_3PAR, 0x0289)},
37 {}
38};
39
40static inline int get_entry_id(int entry)
41{
42 return (entry & ENTRY_MASK_DESCRIPTOR) >> ENTRY_BITPOS_DESCRIPTOR;
43}
44
45static inline int get_entry_len(int entry)
46{
47 return ((entry & ENTRY_MASK_QWORDS) >> ENTRY_BITPOS_QWORDS) << 3;
48}
49
50static inline int mk_entry(int id, int len)
51{
52 int qlen = len & 7 ? (len >> 3) + 1 : len >> 3;
53 return id << ENTRY_BITPOS_DESCRIPTOR | qlen << ENTRY_BITPOS_QWORDS;
54}
55
56static inline int desc_mem_sz(int nr_entry)
57{
58 return nr_entry << L2_QENTRY_SZ;
59}
60
61/*
62 * FIFO queues, shared with hardware.
63 *
64 * If a queue has empty slots, an entry is added to the queue tail,
65 * and that entry is marked as occupied.
66 * Entries can be dequeued from the head of the list, when the device
67 * has marked the entry as consumed.
68 *
69 * Returns true on successful queue/dequeue, false on failure.
70 */
71static int fifo_enqueue(struct ilo_hwinfo *hw, char *fifobar, int entry)
72{
73 struct fifo *fifo_q = FIFOBARTOHANDLE(fifobar);
74 unsigned long flags;
75 int ret = 0;
76
77 spin_lock_irqsave(&hw->fifo_lock, flags);
78 if (!(fifo_q->fifobar[(fifo_q->tail + 1) & fifo_q->imask]
79 & ENTRY_MASK_O)) {
80 fifo_q->fifobar[fifo_q->tail & fifo_q->imask] |=
81 (entry & ENTRY_MASK_NOSTATE) | fifo_q->merge;
82 fifo_q->tail += 1;
83 ret = 1;
84 }
85 spin_unlock_irqrestore(&hw->fifo_lock, flags);
86
87 return ret;
88}
89
90static int fifo_dequeue(struct ilo_hwinfo *hw, char *fifobar, int *entry)
91{
92 struct fifo *fifo_q = FIFOBARTOHANDLE(fifobar);
93 unsigned long flags;
94 int ret = 0;
95 u64 c;
96
97 spin_lock_irqsave(&hw->fifo_lock, flags);
98 c = fifo_q->fifobar[fifo_q->head & fifo_q->imask];
99 if (c & ENTRY_MASK_C) {
100 if (entry)
101 *entry = c & ENTRY_MASK_NOSTATE;
102
103 fifo_q->fifobar[fifo_q->head & fifo_q->imask] =
104 (c | ENTRY_MASK) + 1;
105 fifo_q->head += 1;
106 ret = 1;
107 }
108 spin_unlock_irqrestore(&hw->fifo_lock, flags);
109
110 return ret;
111}
112
113static int fifo_check_recv(struct ilo_hwinfo *hw, char *fifobar)
114{
115 struct fifo *fifo_q = FIFOBARTOHANDLE(fifobar);
116 unsigned long flags;
117 int ret = 0;
118 u64 c;
119
120 spin_lock_irqsave(&hw->fifo_lock, flags);
121 c = fifo_q->fifobar[fifo_q->head & fifo_q->imask];
122 if (c & ENTRY_MASK_C)
123 ret = 1;
124 spin_unlock_irqrestore(&hw->fifo_lock, flags);
125
126 return ret;
127}
128
129static int ilo_pkt_enqueue(struct ilo_hwinfo *hw, struct ccb *ccb,
130 int dir, int id, int len)
131{
132 char *fifobar;
133 int entry;
134
135 if (dir == SENDQ)
136 fifobar = ccb->ccb_u1.send_fifobar;
137 else
138 fifobar = ccb->ccb_u3.recv_fifobar;
139
140 entry = mk_entry(id, len);
141 return fifo_enqueue(hw, fifobar, entry);
142}
143
144static int ilo_pkt_dequeue(struct ilo_hwinfo *hw, struct ccb *ccb,
145 int dir, int *id, int *len, void **pkt)
146{
147 char *fifobar, *desc;
148 int entry = 0, pkt_id = 0;
149 int ret;
150
151 if (dir == SENDQ) {
152 fifobar = ccb->ccb_u1.send_fifobar;
153 desc = ccb->ccb_u2.send_desc;
154 } else {
155 fifobar = ccb->ccb_u3.recv_fifobar;
156 desc = ccb->ccb_u4.recv_desc;
157 }
158
159 ret = fifo_dequeue(hw, fifobar, &entry);
160 if (ret) {
161 pkt_id = get_entry_id(entry);
162 if (id)
163 *id = pkt_id;
164 if (len)
165 *len = get_entry_len(entry);
166 if (pkt)
167 *pkt = (void *)(desc + desc_mem_sz(pkt_id));
168 }
169
170 return ret;
171}
172
173static int ilo_pkt_recv(struct ilo_hwinfo *hw, struct ccb *ccb)
174{
175 char *fifobar = ccb->ccb_u3.recv_fifobar;
176
177 return fifo_check_recv(hw, fifobar);
178}
179
180static inline void doorbell_set(struct ccb *ccb)
181{
182 iowrite8(1, ccb->ccb_u5.db_base);
183}
184
185static inline void doorbell_clr(struct ccb *ccb)
186{
187 iowrite8(2, ccb->ccb_u5.db_base);
188}
189
190static inline int ctrl_set(int l2sz, int idxmask, int desclim)
191{
192 int active = 0, go = 1;
193 return l2sz << CTRL_BITPOS_L2SZ |
194 idxmask << CTRL_BITPOS_FIFOINDEXMASK |
195 desclim << CTRL_BITPOS_DESCLIMIT |
196 active << CTRL_BITPOS_A |
197 go << CTRL_BITPOS_G;
198}
199
200static void ctrl_setup(struct ccb *ccb, int nr_desc, int l2desc_sz)
201{
202 /* for simplicity, use the same parameters for send and recv ctrls */
203 ccb->send_ctrl = ctrl_set(l2desc_sz, nr_desc-1, nr_desc-1);
204 ccb->recv_ctrl = ctrl_set(l2desc_sz, nr_desc-1, nr_desc-1);
205}
206
207static inline int fifo_sz(int nr_entry)
208{
209 /* size of a fifo is determined by the number of entries it contains */
210 return nr_entry * sizeof(u64) + FIFOHANDLESIZE;
211}
212
213static void fifo_setup(void *base_addr, int nr_entry)
214{
215 struct fifo *fifo_q = base_addr;
216 int i;
217
218 /* set up an empty fifo */
219 fifo_q->head = 0;
220 fifo_q->tail = 0;
221 fifo_q->reset = 0;
222 fifo_q->nrents = nr_entry;
223 fifo_q->imask = nr_entry - 1;
224 fifo_q->merge = ENTRY_MASK_O;
225
226 for (i = 0; i < nr_entry; i++)
227 fifo_q->fifobar[i] = 0;
228}
229
230static void ilo_ccb_close(struct pci_dev *pdev, struct ccb_data *data)
231{
232 struct ccb *driver_ccb = &data->driver_ccb;
233 struct ccb __iomem *device_ccb = data->mapped_ccb;
234 int retries;
235
236 /* complicated dance to tell the hw we are stopping */
237 doorbell_clr(driver_ccb);
238 iowrite32(ioread32(&device_ccb->send_ctrl) & ~(1 << CTRL_BITPOS_G),
239 &device_ccb->send_ctrl);
240 iowrite32(ioread32(&device_ccb->recv_ctrl) & ~(1 << CTRL_BITPOS_G),
241 &device_ccb->recv_ctrl);
242
243 /* give iLO some time to process stop request */
244 for (retries = MAX_WAIT; retries > 0; retries--) {
245 doorbell_set(driver_ccb);
246 udelay(WAIT_TIME);
247 if (!(ioread32(&device_ccb->send_ctrl) & (1 << CTRL_BITPOS_A))
248 &&
249 !(ioread32(&device_ccb->recv_ctrl) & (1 << CTRL_BITPOS_A)))
250 break;
251 }
252 if (retries == 0)
253 dev_err(&pdev->dev, "Closing, but controller still active\n");
254
255 /* clear the hw ccb */
256 memset_io(device_ccb, 0, sizeof(struct ccb));
257
258 /* free resources used to back send/recv queues */
259 dma_free_coherent(&pdev->dev, data->dma_size, data->dma_va,
260 data->dma_pa);
261}
262
263static int ilo_ccb_setup(struct ilo_hwinfo *hw, struct ccb_data *data, int slot)
264{
265 char *dma_va;
266 dma_addr_t dma_pa;
267 struct ccb *driver_ccb, *ilo_ccb;
268
269 driver_ccb = &data->driver_ccb;
270 ilo_ccb = &data->ilo_ccb;
271
272 data->dma_size = 2 * fifo_sz(NR_QENTRY) +
273 2 * desc_mem_sz(NR_QENTRY) +
274 ILO_START_ALIGN + ILO_CACHE_SZ;
275
276 data->dma_va = dma_alloc_coherent(&hw->ilo_dev->dev, data->dma_size,
277 &data->dma_pa, GFP_ATOMIC);
278 if (!data->dma_va)
279 return -ENOMEM;
280
281 dma_va = (char *)data->dma_va;
282 dma_pa = data->dma_pa;
283
284 dma_va = (char *)roundup((unsigned long)dma_va, ILO_START_ALIGN);
285 dma_pa = roundup(dma_pa, ILO_START_ALIGN);
286
287 /*
288 * Create two ccb's, one with virt addrs, one with phys addrs.
289 * Copy the phys addr ccb to device shared mem.
290 */
291 ctrl_setup(driver_ccb, NR_QENTRY, L2_QENTRY_SZ);
292 ctrl_setup(ilo_ccb, NR_QENTRY, L2_QENTRY_SZ);
293
294 fifo_setup(dma_va, NR_QENTRY);
295 driver_ccb->ccb_u1.send_fifobar = dma_va + FIFOHANDLESIZE;
296 ilo_ccb->ccb_u1.send_fifobar_pa = dma_pa + FIFOHANDLESIZE;
297 dma_va += fifo_sz(NR_QENTRY);
298 dma_pa += fifo_sz(NR_QENTRY);
299
300 dma_va = (char *)roundup((unsigned long)dma_va, ILO_CACHE_SZ);
301 dma_pa = roundup(dma_pa, ILO_CACHE_SZ);
302
303 fifo_setup(dma_va, NR_QENTRY);
304 driver_ccb->ccb_u3.recv_fifobar = dma_va + FIFOHANDLESIZE;
305 ilo_ccb->ccb_u3.recv_fifobar_pa = dma_pa + FIFOHANDLESIZE;
306 dma_va += fifo_sz(NR_QENTRY);
307 dma_pa += fifo_sz(NR_QENTRY);
308
309 driver_ccb->ccb_u2.send_desc = dma_va;
310 ilo_ccb->ccb_u2.send_desc_pa = dma_pa;
311 dma_pa += desc_mem_sz(NR_QENTRY);
312 dma_va += desc_mem_sz(NR_QENTRY);
313
314 driver_ccb->ccb_u4.recv_desc = dma_va;
315 ilo_ccb->ccb_u4.recv_desc_pa = dma_pa;
316
317 driver_ccb->channel = slot;
318 ilo_ccb->channel = slot;
319
320 driver_ccb->ccb_u5.db_base = hw->db_vaddr + (slot << L2_DB_SIZE);
321 ilo_ccb->ccb_u5.db_base = NULL; /* hw ccb's doorbell is not used */
322
323 return 0;
324}
325
326static void ilo_ccb_open(struct ilo_hwinfo *hw, struct ccb_data *data, int slot)
327{
328 int pkt_id, pkt_sz;
329 struct ccb *driver_ccb = &data->driver_ccb;
330
331 /* copy the ccb with physical addrs to device memory */
332 data->mapped_ccb = (struct ccb __iomem *)
333 (hw->ram_vaddr + (slot * ILOHW_CCB_SZ));
334 memcpy_toio(data->mapped_ccb, &data->ilo_ccb, sizeof(struct ccb));
335
336 /* put packets on the send and receive queues */
337 pkt_sz = 0;
338 for (pkt_id = 0; pkt_id < NR_QENTRY; pkt_id++) {
339 ilo_pkt_enqueue(hw, driver_ccb, SENDQ, pkt_id, pkt_sz);
340 doorbell_set(driver_ccb);
341 }
342
343 pkt_sz = desc_mem_sz(1);
344 for (pkt_id = 0; pkt_id < NR_QENTRY; pkt_id++)
345 ilo_pkt_enqueue(hw, driver_ccb, RECVQ, pkt_id, pkt_sz);
346
347 /* the ccb is ready to use */
348 doorbell_clr(driver_ccb);
349}
350
351static int ilo_ccb_verify(struct ilo_hwinfo *hw, struct ccb_data *data)
352{
353 int pkt_id, i;
354 struct ccb *driver_ccb = &data->driver_ccb;
355
356 /* make sure iLO is really handling requests */
357 for (i = MAX_WAIT; i > 0; i--) {
358 if (ilo_pkt_dequeue(hw, driver_ccb, SENDQ, &pkt_id, NULL, NULL))
359 break;
360 udelay(WAIT_TIME);
361 }
362
363 if (i == 0) {
364 dev_err(&hw->ilo_dev->dev, "Open could not dequeue a packet\n");
365 return -EBUSY;
366 }
367
368 ilo_pkt_enqueue(hw, driver_ccb, SENDQ, pkt_id, 0);
369 doorbell_set(driver_ccb);
370 return 0;
371}
372
373static inline int is_channel_reset(struct ccb *ccb)
374{
375 /* check for this particular channel needing a reset */
376 return FIFOBARTOHANDLE(ccb->ccb_u1.send_fifobar)->reset;
377}
378
379static inline void set_channel_reset(struct ccb *ccb)
380{
381 /* set a flag indicating this channel needs a reset */
382 FIFOBARTOHANDLE(ccb->ccb_u1.send_fifobar)->reset = 1;
383}
384
385static inline int get_device_outbound(struct ilo_hwinfo *hw)
386{
387 return ioread32(&hw->mmio_vaddr[DB_OUT]);
388}
389
390static inline int is_db_reset(int db_out)
391{
392 return db_out & (1 << DB_RESET);
393}
394
395static inline int is_device_reset(struct ilo_hwinfo *hw)
396{
397 /* check for global reset condition */
398 return is_db_reset(get_device_outbound(hw));
399}
400
401static inline void clear_pending_db(struct ilo_hwinfo *hw, int clr)
402{
403 iowrite32(clr, &hw->mmio_vaddr[DB_OUT]);
404}
405
406static inline void clear_device(struct ilo_hwinfo *hw)
407{
408 /* clear the device (reset bits, pending channel entries) */
409 clear_pending_db(hw, -1);
410}
411
412static inline void ilo_enable_interrupts(struct ilo_hwinfo *hw)
413{
414 iowrite8(ioread8(&hw->mmio_vaddr[DB_IRQ]) | 1, &hw->mmio_vaddr[DB_IRQ]);
415}
416
417static inline void ilo_disable_interrupts(struct ilo_hwinfo *hw)
418{
419 iowrite8(ioread8(&hw->mmio_vaddr[DB_IRQ]) & ~1,
420 &hw->mmio_vaddr[DB_IRQ]);
421}
422
423static void ilo_set_reset(struct ilo_hwinfo *hw)
424{
425 int slot;
426
427 /*
428 * Mapped memory is zeroed on ilo reset, so set a per ccb flag
429 * to indicate that this ccb needs to be closed and reopened.
430 */
431 for (slot = 0; slot < max_ccb; slot++) {
432 if (!hw->ccb_alloc[slot])
433 continue;
434 set_channel_reset(&hw->ccb_alloc[slot]->driver_ccb);
435 }
436}
437
438static ssize_t ilo_read(struct file *fp, char __user *buf,
439 size_t len, loff_t *off)
440{
441 int err, found, cnt, pkt_id, pkt_len;
442 struct ccb_data *data = fp->private_data;
443 struct ccb *driver_ccb = &data->driver_ccb;
444 struct ilo_hwinfo *hw = data->ilo_hw;
445 void *pkt;
446
447 if (is_channel_reset(driver_ccb)) {
448 /*
449 * If the device has been reset, applications
450 * need to close and reopen all ccbs.
451 */
452 return -ENODEV;
453 }
454
455 /*
456 * This function is to be called when data is expected
457 * in the channel, and will return an error if no packet is found
458 * during the loop below. The sleep/retry logic is to allow
459 * applications to call read() immediately post write(),
460 * and give iLO some time to process the sent packet.
461 */
462 cnt = 20;
463 do {
464 /* look for a received packet */
465 found = ilo_pkt_dequeue(hw, driver_ccb, RECVQ, &pkt_id,
466 &pkt_len, &pkt);
467 if (found)
468 break;
469 cnt--;
470 msleep(100);
471 } while (!found && cnt);
472
473 if (!found)
474 return -EAGAIN;
475
476 /* only copy the length of the received packet */
477 if (pkt_len < len)
478 len = pkt_len;
479
480 err = copy_to_user(buf, pkt, len);
481
482 /* return the received packet to the queue */
483 ilo_pkt_enqueue(hw, driver_ccb, RECVQ, pkt_id, desc_mem_sz(1));
484
485 return err ? -EFAULT : len;
486}
487
488static ssize_t ilo_write(struct file *fp, const char __user *buf,
489 size_t len, loff_t *off)
490{
491 int err, pkt_id, pkt_len;
492 struct ccb_data *data = fp->private_data;
493 struct ccb *driver_ccb = &data->driver_ccb;
494 struct ilo_hwinfo *hw = data->ilo_hw;
495 void *pkt;
496
497 if (is_channel_reset(driver_ccb))
498 return -ENODEV;
499
500 /* get a packet to send the user command */
501 if (!ilo_pkt_dequeue(hw, driver_ccb, SENDQ, &pkt_id, &pkt_len, &pkt))
502 return -EBUSY;
503
504 /* limit the length to the length of the packet */
505 if (pkt_len < len)
506 len = pkt_len;
507
508 /* on failure, set the len to 0 to return empty packet to the device */
509 err = copy_from_user(pkt, buf, len);
510 if (err)
511 len = 0;
512
513 /* send the packet */
514 ilo_pkt_enqueue(hw, driver_ccb, SENDQ, pkt_id, len);
515 doorbell_set(driver_ccb);
516
517 return err ? -EFAULT : len;
518}
519
520static __poll_t ilo_poll(struct file *fp, poll_table *wait)
521{
522 struct ccb_data *data = fp->private_data;
523 struct ccb *driver_ccb = &data->driver_ccb;
524
525 poll_wait(fp, &data->ccb_waitq, wait);
526
527 if (is_channel_reset(driver_ccb))
528 return EPOLLERR;
529 else if (ilo_pkt_recv(data->ilo_hw, driver_ccb))
530 return EPOLLIN | EPOLLRDNORM;
531
532 return 0;
533}
534
535static int ilo_close(struct inode *ip, struct file *fp)
536{
537 int slot;
538 struct ccb_data *data;
539 struct ilo_hwinfo *hw;
540 unsigned long flags;
541
542 slot = iminor(ip) % max_ccb;
543 hw = container_of(ip->i_cdev, struct ilo_hwinfo, cdev);
544
545 spin_lock(&hw->open_lock);
546
547 if (hw->ccb_alloc[slot]->ccb_cnt == 1) {
548
549 data = fp->private_data;
550
551 spin_lock_irqsave(&hw->alloc_lock, flags);
552 hw->ccb_alloc[slot] = NULL;
553 spin_unlock_irqrestore(&hw->alloc_lock, flags);
554
555 ilo_ccb_close(hw->ilo_dev, data);
556
557 kfree(data);
558 } else
559 hw->ccb_alloc[slot]->ccb_cnt--;
560
561 spin_unlock(&hw->open_lock);
562
563 return 0;
564}
565
566static int ilo_open(struct inode *ip, struct file *fp)
567{
568 int slot, error;
569 struct ccb_data *data;
570 struct ilo_hwinfo *hw;
571 unsigned long flags;
572
573 slot = iminor(ip) % max_ccb;
574 hw = container_of(ip->i_cdev, struct ilo_hwinfo, cdev);
575
576 /* new ccb allocation */
577 data = kzalloc(sizeof(*data), GFP_KERNEL);
578 if (!data)
579 return -ENOMEM;
580
581 spin_lock(&hw->open_lock);
582
583 /* each fd private_data holds sw/hw view of ccb */
584 if (hw->ccb_alloc[slot] == NULL) {
585 /* create a channel control block for this minor */
586 error = ilo_ccb_setup(hw, data, slot);
587 if (error) {
588 kfree(data);
589 goto out;
590 }
591
592 data->ccb_cnt = 1;
593 data->ccb_excl = fp->f_flags & O_EXCL;
594 data->ilo_hw = hw;
595 init_waitqueue_head(&data->ccb_waitq);
596
597 /* write the ccb to hw */
598 spin_lock_irqsave(&hw->alloc_lock, flags);
599 ilo_ccb_open(hw, data, slot);
600 hw->ccb_alloc[slot] = data;
601 spin_unlock_irqrestore(&hw->alloc_lock, flags);
602
603 /* make sure the channel is functional */
604 error = ilo_ccb_verify(hw, data);
605 if (error) {
606
607 spin_lock_irqsave(&hw->alloc_lock, flags);
608 hw->ccb_alloc[slot] = NULL;
609 spin_unlock_irqrestore(&hw->alloc_lock, flags);
610
611 ilo_ccb_close(hw->ilo_dev, data);
612
613 kfree(data);
614 goto out;
615 }
616
617 } else {
618 kfree(data);
619 if (fp->f_flags & O_EXCL || hw->ccb_alloc[slot]->ccb_excl) {
620 /*
621 * The channel exists, and either this open
622 * or a previous open of this channel wants
623 * exclusive access.
624 */
625 error = -EBUSY;
626 } else {
627 hw->ccb_alloc[slot]->ccb_cnt++;
628 error = 0;
629 }
630 }
631out:
632 spin_unlock(&hw->open_lock);
633
634 if (!error)
635 fp->private_data = hw->ccb_alloc[slot];
636
637 return error;
638}
639
640static const struct file_operations ilo_fops = {
641 .owner = THIS_MODULE,
642 .read = ilo_read,
643 .write = ilo_write,
644 .poll = ilo_poll,
645 .open = ilo_open,
646 .release = ilo_close,
647 .llseek = noop_llseek,
648};
649
650static irqreturn_t ilo_isr(int irq, void *data)
651{
652 struct ilo_hwinfo *hw = data;
653 int pending, i;
654
655 spin_lock(&hw->alloc_lock);
656
657 /* check for ccbs which have data */
658 pending = get_device_outbound(hw);
659 if (!pending) {
660 spin_unlock(&hw->alloc_lock);
661 return IRQ_NONE;
662 }
663
664 if (is_db_reset(pending)) {
665 /* wake up all ccbs if the device was reset */
666 pending = -1;
667 ilo_set_reset(hw);
668 }
669
670 for (i = 0; i < max_ccb; i++) {
671 if (!hw->ccb_alloc[i])
672 continue;
673 if (pending & (1 << i))
674 wake_up_interruptible(&hw->ccb_alloc[i]->ccb_waitq);
675 }
676
677 /* clear the device of the channels that have been handled */
678 clear_pending_db(hw, pending);
679
680 spin_unlock(&hw->alloc_lock);
681
682 return IRQ_HANDLED;
683}
684
685static void ilo_unmap_device(struct pci_dev *pdev, struct ilo_hwinfo *hw)
686{
687 pci_iounmap(pdev, hw->db_vaddr);
688 pci_iounmap(pdev, hw->ram_vaddr);
689 pci_iounmap(pdev, hw->mmio_vaddr);
690}
691
692static int ilo_map_device(struct pci_dev *pdev, struct ilo_hwinfo *hw)
693{
694 int bar;
695 unsigned long off;
696 u8 pci_rev_id;
697 int rc;
698
699 /* map the memory mapped i/o registers */
700 hw->mmio_vaddr = pci_iomap(pdev, 1, 0);
701 if (hw->mmio_vaddr == NULL) {
702 dev_err(&pdev->dev, "Error mapping mmio\n");
703 goto out;
704 }
705
706 /* map the adapter shared memory region */
707 rc = pci_read_config_byte(pdev, PCI_REVISION_ID, &pci_rev_id);
708 if (rc != 0) {
709 dev_err(&pdev->dev, "Error reading PCI rev id: %d\n", rc);
710 goto out;
711 }
712
713 if (pci_rev_id >= PCI_REV_ID_NECHES) {
714 bar = 5;
715 /* Last 8k is reserved for CCBs */
716 off = pci_resource_len(pdev, bar) - 0x2000;
717 } else {
718 bar = 2;
719 off = 0;
720 }
721 hw->ram_vaddr = pci_iomap_range(pdev, bar, off, max_ccb * ILOHW_CCB_SZ);
722 if (hw->ram_vaddr == NULL) {
723 dev_err(&pdev->dev, "Error mapping shared mem\n");
724 goto mmio_free;
725 }
726
727 /* map the doorbell aperture */
728 hw->db_vaddr = pci_iomap(pdev, 3, max_ccb * ONE_DB_SIZE);
729 if (hw->db_vaddr == NULL) {
730 dev_err(&pdev->dev, "Error mapping doorbell\n");
731 goto ram_free;
732 }
733
734 return 0;
735ram_free:
736 pci_iounmap(pdev, hw->ram_vaddr);
737mmio_free:
738 pci_iounmap(pdev, hw->mmio_vaddr);
739out:
740 return -ENOMEM;
741}
742
743static void ilo_remove(struct pci_dev *pdev)
744{
745 int i, minor;
746 struct ilo_hwinfo *ilo_hw = pci_get_drvdata(pdev);
747
748 if (!ilo_hw)
749 return;
750
751 clear_device(ilo_hw);
752
753 minor = MINOR(ilo_hw->cdev.dev);
754 for (i = minor; i < minor + max_ccb; i++)
755 device_destroy(ilo_class, MKDEV(ilo_major, i));
756
757 cdev_del(&ilo_hw->cdev);
758 ilo_disable_interrupts(ilo_hw);
759 free_irq(pdev->irq, ilo_hw);
760 ilo_unmap_device(pdev, ilo_hw);
761 pci_release_regions(pdev);
762 /*
763 * pci_disable_device(pdev) used to be here. But this PCI device has
764 * two functions with interrupt lines connected to a single pin. The
765 * other one is a USB host controller. So when we disable the PIN here
766 * e.g. by rmmod hpilo, the controller stops working. It is because
767 * the interrupt link is disabled in ACPI since it is not refcounted
768 * yet. See acpi_pci_link_free_irq called from acpi_pci_irq_disable.
769 */
770 kfree(ilo_hw);
771 ilo_hwdev[(minor / max_ccb)] = 0;
772}
773
774static int ilo_probe(struct pci_dev *pdev,
775 const struct pci_device_id *ent)
776{
777 int devnum, minor, start, error = 0;
778 struct ilo_hwinfo *ilo_hw;
779
780 if (pci_match_id(ilo_blacklist, pdev)) {
781 dev_dbg(&pdev->dev, "Not supported on this device\n");
782 return -ENODEV;
783 }
784
785 if (max_ccb > MAX_CCB)
786 max_ccb = MAX_CCB;
787 else if (max_ccb < MIN_CCB)
788 max_ccb = MIN_CCB;
789
790 /* find a free range for device files */
791 for (devnum = 0; devnum < MAX_ILO_DEV; devnum++) {
792 if (ilo_hwdev[devnum] == 0) {
793 ilo_hwdev[devnum] = 1;
794 break;
795 }
796 }
797
798 if (devnum == MAX_ILO_DEV) {
799 dev_err(&pdev->dev, "Error finding free device\n");
800 return -ENODEV;
801 }
802
803 /* track global allocations for this device */
804 error = -ENOMEM;
805 ilo_hw = kzalloc(sizeof(*ilo_hw), GFP_KERNEL);
806 if (!ilo_hw)
807 goto out;
808
809 ilo_hw->ilo_dev = pdev;
810 spin_lock_init(&ilo_hw->alloc_lock);
811 spin_lock_init(&ilo_hw->fifo_lock);
812 spin_lock_init(&ilo_hw->open_lock);
813
814 error = pci_enable_device(pdev);
815 if (error)
816 goto free;
817
818 pci_set_master(pdev);
819
820 error = pci_request_regions(pdev, ILO_NAME);
821 if (error)
822 goto disable;
823
824 error = ilo_map_device(pdev, ilo_hw);
825 if (error)
826 goto free_regions;
827
828 pci_set_drvdata(pdev, ilo_hw);
829 clear_device(ilo_hw);
830
831 error = request_irq(pdev->irq, ilo_isr, IRQF_SHARED, "hpilo", ilo_hw);
832 if (error)
833 goto unmap;
834
835 ilo_enable_interrupts(ilo_hw);
836
837 cdev_init(&ilo_hw->cdev, &ilo_fops);
838 ilo_hw->cdev.owner = THIS_MODULE;
839 start = devnum * max_ccb;
840 error = cdev_add(&ilo_hw->cdev, MKDEV(ilo_major, start), max_ccb);
841 if (error) {
842 dev_err(&pdev->dev, "Could not add cdev\n");
843 goto remove_isr;
844 }
845
846 for (minor = 0 ; minor < max_ccb; minor++) {
847 struct device *dev;
848 dev = device_create(ilo_class, &pdev->dev,
849 MKDEV(ilo_major, minor), NULL,
850 "hpilo!d%dccb%d", devnum, minor);
851 if (IS_ERR(dev))
852 dev_err(&pdev->dev, "Could not create files\n");
853 }
854
855 return 0;
856remove_isr:
857 ilo_disable_interrupts(ilo_hw);
858 free_irq(pdev->irq, ilo_hw);
859unmap:
860 ilo_unmap_device(pdev, ilo_hw);
861free_regions:
862 pci_release_regions(pdev);
863disable:
864/* pci_disable_device(pdev); see comment in ilo_remove */
865free:
866 kfree(ilo_hw);
867out:
868 ilo_hwdev[devnum] = 0;
869 return error;
870}
871
872static const struct pci_device_id ilo_devices[] = {
873 { PCI_DEVICE(PCI_VENDOR_ID_COMPAQ, 0xB204) },
874 { PCI_DEVICE(PCI_VENDOR_ID_HP, 0x3307) },
875 { }
876};
877MODULE_DEVICE_TABLE(pci, ilo_devices);
878
879static struct pci_driver ilo_driver = {
880 .name = ILO_NAME,
881 .id_table = ilo_devices,
882 .probe = ilo_probe,
883 .remove = ilo_remove,
884};
885
886static int __init ilo_init(void)
887{
888 int error;
889 dev_t dev;
890
891 ilo_class = class_create(THIS_MODULE, "iLO");
892 if (IS_ERR(ilo_class)) {
893 error = PTR_ERR(ilo_class);
894 goto out;
895 }
896
897 error = alloc_chrdev_region(&dev, 0, MAX_OPEN, ILO_NAME);
898 if (error)
899 goto class_destroy;
900
901 ilo_major = MAJOR(dev);
902
903 error = pci_register_driver(&ilo_driver);
904 if (error)
905 goto chr_remove;
906
907 return 0;
908chr_remove:
909 unregister_chrdev_region(dev, MAX_OPEN);
910class_destroy:
911 class_destroy(ilo_class);
912out:
913 return error;
914}
915
916static void __exit ilo_exit(void)
917{
918 pci_unregister_driver(&ilo_driver);
919 unregister_chrdev_region(MKDEV(ilo_major, 0), MAX_OPEN);
920 class_destroy(ilo_class);
921}
922
923MODULE_VERSION("1.5.0");
924MODULE_ALIAS(ILO_NAME);
925MODULE_DESCRIPTION(ILO_NAME);
926MODULE_AUTHOR("David Altobelli <david.altobelli@hpe.com>");
927MODULE_LICENSE("GPL v2");
928
929module_param(max_ccb, uint, 0444);
930MODULE_PARM_DESC(max_ccb, "Maximum number of HP iLO channels to attach (8-24)(default=16)");
931
932module_init(ilo_init);
933module_exit(ilo_exit);