2 * IBM Accelerator Family 'GenWQE'
4 * (C) Copyright IBM Corp. 2013
6 * Author: Frank Haverkamp <haver@linux.vnet.ibm.com>
7 * Author: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
8 * Author: Michael Jung <mijung@gmx.net>
9 * Author: Michael Ruettger <michael@ibmra.de>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License (version 2 only)
13 * as published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
22 * Character device representation of the GenWQE device. This allows
23 * user-space applications to communicate with the card.
26 #include <linux/kernel.h>
27 #include <linux/types.h>
28 #include <linux/module.h>
29 #include <linux/pci.h>
30 #include <linux/string.h>
32 #include <linux/sched/signal.h>
33 #include <linux/wait.h>
34 #include <linux/delay.h>
35 #include <linux/atomic.h>
37 #include "card_base.h"
38 #include "card_ddcb.h"
40 static int genwqe_open_files(struct genwqe_dev
*cd
)
45 spin_lock_irqsave(&cd
->file_lock
, flags
);
46 rc
= list_empty(&cd
->file_list
);
47 spin_unlock_irqrestore(&cd
->file_lock
, flags
);
51 static void genwqe_add_file(struct genwqe_dev
*cd
, struct genwqe_file
*cfile
)
55 cfile
->owner
= current
;
56 spin_lock_irqsave(&cd
->file_lock
, flags
);
57 list_add(&cfile
->list
, &cd
->file_list
);
58 spin_unlock_irqrestore(&cd
->file_lock
, flags
);
61 static int genwqe_del_file(struct genwqe_dev
*cd
, struct genwqe_file
*cfile
)
65 spin_lock_irqsave(&cd
->file_lock
, flags
);
66 list_del(&cfile
->list
);
67 spin_unlock_irqrestore(&cd
->file_lock
, flags
);
72 static void genwqe_add_pin(struct genwqe_file
*cfile
, struct dma_mapping
*m
)
76 spin_lock_irqsave(&cfile
->pin_lock
, flags
);
77 list_add(&m
->pin_list
, &cfile
->pin_list
);
78 spin_unlock_irqrestore(&cfile
->pin_lock
, flags
);
81 static int genwqe_del_pin(struct genwqe_file
*cfile
, struct dma_mapping
*m
)
85 spin_lock_irqsave(&cfile
->pin_lock
, flags
);
86 list_del(&m
->pin_list
);
87 spin_unlock_irqrestore(&cfile
->pin_lock
, flags
);
93 * genwqe_search_pin() - Search for the mapping for a userspace address
94 * @cfile: Descriptor of opened file
95 * @u_addr: User virtual address
96 * @size: Size of buffer
97 * @dma_addr: DMA address to be updated
99 * Return: Pointer to the corresponding mapping NULL if not found
101 static struct dma_mapping
*genwqe_search_pin(struct genwqe_file
*cfile
,
102 unsigned long u_addr
,
107 struct dma_mapping
*m
;
109 spin_lock_irqsave(&cfile
->pin_lock
, flags
);
111 list_for_each_entry(m
, &cfile
->pin_list
, pin_list
) {
112 if ((((u64
)m
->u_vaddr
) <= (u_addr
)) &&
113 (((u64
)m
->u_vaddr
+ m
->size
) >= (u_addr
+ size
))) {
116 *virt_addr
= m
->k_vaddr
+
117 (u_addr
- (u64
)m
->u_vaddr
);
119 spin_unlock_irqrestore(&cfile
->pin_lock
, flags
);
123 spin_unlock_irqrestore(&cfile
->pin_lock
, flags
);
127 static void __genwqe_add_mapping(struct genwqe_file
*cfile
,
128 struct dma_mapping
*dma_map
)
132 spin_lock_irqsave(&cfile
->map_lock
, flags
);
133 list_add(&dma_map
->card_list
, &cfile
->map_list
);
134 spin_unlock_irqrestore(&cfile
->map_lock
, flags
);
137 static void __genwqe_del_mapping(struct genwqe_file
*cfile
,
138 struct dma_mapping
*dma_map
)
142 spin_lock_irqsave(&cfile
->map_lock
, flags
);
143 list_del(&dma_map
->card_list
);
144 spin_unlock_irqrestore(&cfile
->map_lock
, flags
);
149 * __genwqe_search_mapping() - Search for the mapping for a userspace address
150 * @cfile: descriptor of opened file
151 * @u_addr: user virtual address
152 * @size: size of buffer
153 * @dma_addr: DMA address to be updated
154 * Return: Pointer to the corresponding mapping NULL if not found
156 static struct dma_mapping
*__genwqe_search_mapping(struct genwqe_file
*cfile
,
157 unsigned long u_addr
,
159 dma_addr_t
*dma_addr
,
163 struct dma_mapping
*m
;
164 struct pci_dev
*pci_dev
= cfile
->cd
->pci_dev
;
166 spin_lock_irqsave(&cfile
->map_lock
, flags
);
167 list_for_each_entry(m
, &cfile
->map_list
, card_list
) {
169 if ((((u64
)m
->u_vaddr
) <= (u_addr
)) &&
170 (((u64
)m
->u_vaddr
+ m
->size
) >= (u_addr
+ size
))) {
172 /* match found: current is as expected and
175 *dma_addr
= m
->dma_addr
+
176 (u_addr
- (u64
)m
->u_vaddr
);
179 *virt_addr
= m
->k_vaddr
+
180 (u_addr
- (u64
)m
->u_vaddr
);
182 spin_unlock_irqrestore(&cfile
->map_lock
, flags
);
186 spin_unlock_irqrestore(&cfile
->map_lock
, flags
);
188 dev_err(&pci_dev
->dev
,
189 "[%s] Entry not found: u_addr=%lx, size=%x\n",
190 __func__
, u_addr
, size
);
195 static void genwqe_remove_mappings(struct genwqe_file
*cfile
)
198 struct list_head
*node
, *next
;
199 struct dma_mapping
*dma_map
;
200 struct genwqe_dev
*cd
= cfile
->cd
;
201 struct pci_dev
*pci_dev
= cfile
->cd
->pci_dev
;
203 list_for_each_safe(node
, next
, &cfile
->map_list
) {
204 dma_map
= list_entry(node
, struct dma_mapping
, card_list
);
206 list_del_init(&dma_map
->card_list
);
209 * This is really a bug, because those things should
210 * have been already tidied up.
212 * GENWQE_MAPPING_RAW should have been removed via mmunmap().
213 * GENWQE_MAPPING_SGL_TEMP should be removed by tidy up code.
215 dev_err(&pci_dev
->dev
,
216 "[%s] %d. cleanup mapping: u_vaddr=%p u_kaddr=%016lx dma_addr=%lx\n",
217 __func__
, i
++, dma_map
->u_vaddr
,
218 (unsigned long)dma_map
->k_vaddr
,
219 (unsigned long)dma_map
->dma_addr
);
221 if (dma_map
->type
== GENWQE_MAPPING_RAW
) {
222 /* we allocated this dynamically */
223 __genwqe_free_consistent(cd
, dma_map
->size
,
227 } else if (dma_map
->type
== GENWQE_MAPPING_SGL_TEMP
) {
228 /* we use dma_map statically from the request */
229 genwqe_user_vunmap(cd
, dma_map
);
234 static void genwqe_remove_pinnings(struct genwqe_file
*cfile
)
236 struct list_head
*node
, *next
;
237 struct dma_mapping
*dma_map
;
238 struct genwqe_dev
*cd
= cfile
->cd
;
240 list_for_each_safe(node
, next
, &cfile
->pin_list
) {
241 dma_map
= list_entry(node
, struct dma_mapping
, pin_list
);
244 * This is not a bug, because a killed processed might
245 * not call the unpin ioctl, which is supposed to free
248 * Pinnings are dymically allocated and need to be
251 list_del_init(&dma_map
->pin_list
);
252 genwqe_user_vunmap(cd
, dma_map
);
258 * genwqe_kill_fasync() - Send signal to all processes with open GenWQE files
260 * E.g. genwqe_send_signal(cd, SIGIO);
262 static int genwqe_kill_fasync(struct genwqe_dev
*cd
, int sig
)
264 unsigned int files
= 0;
266 struct genwqe_file
*cfile
;
268 spin_lock_irqsave(&cd
->file_lock
, flags
);
269 list_for_each_entry(cfile
, &cd
->file_list
, list
) {
270 if (cfile
->async_queue
)
271 kill_fasync(&cfile
->async_queue
, sig
, POLL_HUP
);
274 spin_unlock_irqrestore(&cd
->file_lock
, flags
);
278 static int genwqe_force_sig(struct genwqe_dev
*cd
, int sig
)
280 unsigned int files
= 0;
282 struct genwqe_file
*cfile
;
284 spin_lock_irqsave(&cd
->file_lock
, flags
);
285 list_for_each_entry(cfile
, &cd
->file_list
, list
) {
286 force_sig(sig
, cfile
->owner
);
289 spin_unlock_irqrestore(&cd
->file_lock
, flags
);
294 * genwqe_open() - file open
295 * @inode: file system information
298 * This function is executed whenever an application calls
299 * open("/dev/genwqe",..).
301 * Return: 0 if successful or <0 if errors
303 static int genwqe_open(struct inode
*inode
, struct file
*filp
)
305 struct genwqe_dev
*cd
;
306 struct genwqe_file
*cfile
;
308 cfile
= kzalloc(sizeof(*cfile
), GFP_KERNEL
);
312 cd
= container_of(inode
->i_cdev
, struct genwqe_dev
, cdev_genwqe
);
315 cfile
->client
= NULL
;
317 spin_lock_init(&cfile
->map_lock
); /* list of raw memory allocations */
318 INIT_LIST_HEAD(&cfile
->map_list
);
320 spin_lock_init(&cfile
->pin_lock
); /* list of user pinned memory */
321 INIT_LIST_HEAD(&cfile
->pin_list
);
323 filp
->private_data
= cfile
;
325 genwqe_add_file(cd
, cfile
);
330 * genwqe_fasync() - Setup process to receive SIGIO.
331 * @fd: file descriptor
335 * Sending a signal is working as following:
337 * if (cdev->async_queue)
338 * kill_fasync(&cdev->async_queue, SIGIO, POLL_IN);
340 * Some devices also implement asynchronous notification to indicate
341 * when the device can be written; in this case, of course,
342 * kill_fasync must be called with a mode of POLL_OUT.
344 static int genwqe_fasync(int fd
, struct file
*filp
, int mode
)
346 struct genwqe_file
*cdev
= (struct genwqe_file
*)filp
->private_data
;
348 return fasync_helper(fd
, filp
, mode
, &cdev
->async_queue
);
353 * genwqe_release() - file close
354 * @inode: file system information
357 * This function is executed whenever an application calls 'close(fd_genwqe)'
361 static int genwqe_release(struct inode
*inode
, struct file
*filp
)
363 struct genwqe_file
*cfile
= (struct genwqe_file
*)filp
->private_data
;
364 struct genwqe_dev
*cd
= cfile
->cd
;
366 /* there must be no entries in these lists! */
367 genwqe_remove_mappings(cfile
);
368 genwqe_remove_pinnings(cfile
);
370 /* remove this filp from the asynchronously notified filp's */
371 genwqe_fasync(-1, filp
, 0);
374 * For this to work we must not release cd when this cfile is
375 * not yet released, otherwise the list entry is invalid,
376 * because the list itself gets reinstantiated!
378 genwqe_del_file(cd
, cfile
);
383 static void genwqe_vma_open(struct vm_area_struct
*vma
)
389 * genwqe_vma_close() - Called each time when vma is unmapped
391 * Free memory which got allocated by GenWQE mmap().
393 static void genwqe_vma_close(struct vm_area_struct
*vma
)
395 unsigned long vsize
= vma
->vm_end
- vma
->vm_start
;
396 struct inode
*inode
= file_inode(vma
->vm_file
);
397 struct dma_mapping
*dma_map
;
398 struct genwqe_dev
*cd
= container_of(inode
->i_cdev
, struct genwqe_dev
,
400 struct pci_dev
*pci_dev
= cd
->pci_dev
;
401 dma_addr_t d_addr
= 0;
402 struct genwqe_file
*cfile
= vma
->vm_private_data
;
404 dma_map
= __genwqe_search_mapping(cfile
, vma
->vm_start
, vsize
,
406 if (dma_map
== NULL
) {
407 dev_err(&pci_dev
->dev
,
408 " [%s] err: mapping not found: v=%lx, p=%lx s=%lx\n",
409 __func__
, vma
->vm_start
, vma
->vm_pgoff
<< PAGE_SHIFT
,
413 __genwqe_del_mapping(cfile
, dma_map
);
414 __genwqe_free_consistent(cd
, dma_map
->size
, dma_map
->k_vaddr
,
419 static const struct vm_operations_struct genwqe_vma_ops
= {
420 .open
= genwqe_vma_open
,
421 .close
= genwqe_vma_close
,
425 * genwqe_mmap() - Provide contignous buffers to userspace
427 * We use mmap() to allocate contignous buffers used for DMA
428 * transfers. After the buffer is allocated we remap it to user-space
429 * and remember a reference to our dma_mapping data structure, where
430 * we store the associated DMA address and allocated size.
432 * When we receive a DDCB execution request with the ATS bits set to
433 * plain buffer, we lookup our dma_mapping list to find the
434 * corresponding DMA address for the associated user-space address.
436 static int genwqe_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
439 unsigned long pfn
, vsize
= vma
->vm_end
- vma
->vm_start
;
440 struct genwqe_file
*cfile
= (struct genwqe_file
*)filp
->private_data
;
441 struct genwqe_dev
*cd
= cfile
->cd
;
442 struct dma_mapping
*dma_map
;
447 if (get_order(vsize
) > MAX_ORDER
)
450 dma_map
= kzalloc(sizeof(struct dma_mapping
), GFP_KERNEL
);
454 genwqe_mapping_init(dma_map
, GENWQE_MAPPING_RAW
);
455 dma_map
->u_vaddr
= (void *)vma
->vm_start
;
456 dma_map
->size
= vsize
;
457 dma_map
->nr_pages
= DIV_ROUND_UP(vsize
, PAGE_SIZE
);
458 dma_map
->k_vaddr
= __genwqe_alloc_consistent(cd
, vsize
,
460 if (dma_map
->k_vaddr
== NULL
) {
465 if (capable(CAP_SYS_ADMIN
) && (vsize
> sizeof(dma_addr_t
)))
466 *(dma_addr_t
*)dma_map
->k_vaddr
= dma_map
->dma_addr
;
468 pfn
= virt_to_phys(dma_map
->k_vaddr
) >> PAGE_SHIFT
;
469 rc
= remap_pfn_range(vma
,
479 vma
->vm_private_data
= cfile
;
480 vma
->vm_ops
= &genwqe_vma_ops
;
481 __genwqe_add_mapping(cfile
, dma_map
);
486 __genwqe_free_consistent(cd
, dma_map
->size
,
495 * do_flash_update() - Excute flash update (write image or CVPD)
497 * @load: details about image load
499 * Return: 0 if successful
502 #define FLASH_BLOCK 0x40000 /* we use 256k blocks */
504 static int do_flash_update(struct genwqe_file
*cfile
,
505 struct genwqe_bitstream
*load
)
516 struct genwqe_dev
*cd
= cfile
->cd
;
517 struct file
*filp
= cfile
->filp
;
518 struct pci_dev
*pci_dev
= cd
->pci_dev
;
520 if ((load
->size
& 0x3) != 0)
523 if (((unsigned long)(load
->data_addr
) & ~PAGE_MASK
) != 0)
526 /* FIXME Bits have changed for new service layer! */
527 switch ((char)load
->partition
) {
530 break; /* download/erase_first/part_0 */
533 break; /* download/erase_first/part_1 */
536 break; /* download/erase_first/vpd */
541 buf
= (u8 __user
*)load
->data_addr
;
542 xbuf
= __genwqe_alloc_consistent(cd
, FLASH_BLOCK
, &dma_addr
);
546 blocks_to_flash
= load
->size
/ FLASH_BLOCK
;
548 struct genwqe_ddcb_cmd
*req
;
551 * We must be 4 byte aligned. Buffer must be 0 appened
552 * to have defined values when calculating CRC.
554 tocopy
= min_t(size_t, load
->size
, FLASH_BLOCK
);
556 rc
= copy_from_user(xbuf
, buf
, tocopy
);
561 crc
= genwqe_crc32(xbuf
, tocopy
, 0xffffffff);
563 dev_dbg(&pci_dev
->dev
,
564 "[%s] DMA: %lx CRC: %08x SZ: %ld %d\n",
565 __func__
, (unsigned long)dma_addr
, crc
, tocopy
,
568 /* prepare DDCB for SLU process */
569 req
= ddcb_requ_alloc();
575 req
->cmd
= SLCMD_MOVE_FLASH
;
576 req
->cmdopts
= cmdopts
;
578 /* prepare invariant values */
579 if (genwqe_get_slu_id(cd
) <= 0x2) {
580 *(__be64
*)&req
->__asiv
[0] = cpu_to_be64(dma_addr
);
581 *(__be64
*)&req
->__asiv
[8] = cpu_to_be64(tocopy
);
582 *(__be64
*)&req
->__asiv
[16] = cpu_to_be64(flash
);
583 *(__be32
*)&req
->__asiv
[24] = cpu_to_be32(0);
584 req
->__asiv
[24] = load
->uid
;
585 *(__be32
*)&req
->__asiv
[28] = cpu_to_be32(crc
);
587 /* for simulation only */
588 *(__be64
*)&req
->__asiv
[88] = cpu_to_be64(load
->slu_id
);
589 *(__be64
*)&req
->__asiv
[96] = cpu_to_be64(load
->app_id
);
590 req
->asiv_length
= 32; /* bytes included in crc calc */
591 } else { /* setup DDCB for ATS architecture */
592 *(__be64
*)&req
->asiv
[0] = cpu_to_be64(dma_addr
);
593 *(__be32
*)&req
->asiv
[8] = cpu_to_be32(tocopy
);
594 *(__be32
*)&req
->asiv
[12] = cpu_to_be32(0); /* resvd */
595 *(__be64
*)&req
->asiv
[16] = cpu_to_be64(flash
);
596 *(__be32
*)&req
->asiv
[24] = cpu_to_be32(load
->uid
<<24);
597 *(__be32
*)&req
->asiv
[28] = cpu_to_be32(crc
);
599 /* for simulation only */
600 *(__be64
*)&req
->asiv
[80] = cpu_to_be64(load
->slu_id
);
601 *(__be64
*)&req
->asiv
[88] = cpu_to_be64(load
->app_id
);
604 req
->ats
= 0x4ULL
<< 44;
605 req
->asiv_length
= 40; /* bytes included in crc calc */
609 /* For Genwqe5 we get back the calculated CRC */
610 *(u64
*)&req
->asv
[0] = 0ULL; /* 0x80 */
612 rc
= __genwqe_execute_raw_ddcb(cd
, req
, filp
->f_flags
);
614 load
->retc
= req
->retc
;
615 load
->attn
= req
->attn
;
616 load
->progress
= req
->progress
;
623 if (req
->retc
!= DDCB_RETC_COMPLETE
) {
629 load
->size
-= tocopy
;
637 __genwqe_free_consistent(cd
, FLASH_BLOCK
, xbuf
, dma_addr
);
641 static int do_flash_read(struct genwqe_file
*cfile
,
642 struct genwqe_bitstream
*load
)
644 int rc
, blocks_to_flash
;
651 struct genwqe_dev
*cd
= cfile
->cd
;
652 struct file
*filp
= cfile
->filp
;
653 struct pci_dev
*pci_dev
= cd
->pci_dev
;
654 struct genwqe_ddcb_cmd
*cmd
;
656 if ((load
->size
& 0x3) != 0)
659 if (((unsigned long)(load
->data_addr
) & ~PAGE_MASK
) != 0)
662 /* FIXME Bits have changed for new service layer! */
663 switch ((char)load
->partition
) {
666 break; /* upload/part_0 */
669 break; /* upload/part_1 */
672 break; /* upload/vpd */
677 buf
= (u8 __user
*)load
->data_addr
;
678 xbuf
= __genwqe_alloc_consistent(cd
, FLASH_BLOCK
, &dma_addr
);
682 blocks_to_flash
= load
->size
/ FLASH_BLOCK
;
685 * We must be 4 byte aligned. Buffer must be 0 appened
686 * to have defined values when calculating CRC.
688 tocopy
= min_t(size_t, load
->size
, FLASH_BLOCK
);
690 dev_dbg(&pci_dev
->dev
,
691 "[%s] DMA: %lx SZ: %ld %d\n",
692 __func__
, (unsigned long)dma_addr
, tocopy
,
695 /* prepare DDCB for SLU process */
696 cmd
= ddcb_requ_alloc();
701 cmd
->cmd
= SLCMD_MOVE_FLASH
;
702 cmd
->cmdopts
= cmdopts
;
704 /* prepare invariant values */
705 if (genwqe_get_slu_id(cd
) <= 0x2) {
706 *(__be64
*)&cmd
->__asiv
[0] = cpu_to_be64(dma_addr
);
707 *(__be64
*)&cmd
->__asiv
[8] = cpu_to_be64(tocopy
);
708 *(__be64
*)&cmd
->__asiv
[16] = cpu_to_be64(flash
);
709 *(__be32
*)&cmd
->__asiv
[24] = cpu_to_be32(0);
710 cmd
->__asiv
[24] = load
->uid
;
711 *(__be32
*)&cmd
->__asiv
[28] = cpu_to_be32(0) /* CRC */;
712 cmd
->asiv_length
= 32; /* bytes included in crc calc */
713 } else { /* setup DDCB for ATS architecture */
714 *(__be64
*)&cmd
->asiv
[0] = cpu_to_be64(dma_addr
);
715 *(__be32
*)&cmd
->asiv
[8] = cpu_to_be32(tocopy
);
716 *(__be32
*)&cmd
->asiv
[12] = cpu_to_be32(0); /* resvd */
717 *(__be64
*)&cmd
->asiv
[16] = cpu_to_be64(flash
);
718 *(__be32
*)&cmd
->asiv
[24] = cpu_to_be32(load
->uid
<<24);
719 *(__be32
*)&cmd
->asiv
[28] = cpu_to_be32(0); /* CRC */
722 cmd
->ats
= 0x5ULL
<< 44;
723 cmd
->asiv_length
= 40; /* bytes included in crc calc */
727 /* we only get back the calculated CRC */
728 *(u64
*)&cmd
->asv
[0] = 0ULL; /* 0x80 */
730 rc
= __genwqe_execute_raw_ddcb(cd
, cmd
, filp
->f_flags
);
732 load
->retc
= cmd
->retc
;
733 load
->attn
= cmd
->attn
;
734 load
->progress
= cmd
->progress
;
736 if ((rc
< 0) && (rc
!= -EBADMSG
)) {
741 rc
= copy_to_user(buf
, xbuf
, tocopy
);
748 /* We know that we can get retc 0x104 with CRC err */
749 if (((cmd
->retc
== DDCB_RETC_FAULT
) &&
750 (cmd
->attn
!= 0x02)) || /* Normally ignore CRC error */
751 ((cmd
->retc
== DDCB_RETC_COMPLETE
) &&
752 (cmd
->attn
!= 0x00))) { /* Everything was fine */
758 load
->size
-= tocopy
;
767 __genwqe_free_consistent(cd
, FLASH_BLOCK
, xbuf
, dma_addr
);
771 static int genwqe_pin_mem(struct genwqe_file
*cfile
, struct genwqe_mem
*m
)
774 struct genwqe_dev
*cd
= cfile
->cd
;
775 struct pci_dev
*pci_dev
= cfile
->cd
->pci_dev
;
776 struct dma_mapping
*dma_map
;
777 unsigned long map_addr
;
778 unsigned long map_size
;
780 if ((m
->addr
== 0x0) || (m
->size
== 0))
783 map_addr
= (m
->addr
& PAGE_MASK
);
784 map_size
= round_up(m
->size
+ (m
->addr
& ~PAGE_MASK
), PAGE_SIZE
);
786 dma_map
= kzalloc(sizeof(struct dma_mapping
), GFP_KERNEL
);
790 genwqe_mapping_init(dma_map
, GENWQE_MAPPING_SGL_PINNED
);
791 rc
= genwqe_user_vmap(cd
, dma_map
, (void *)map_addr
, map_size
);
793 dev_err(&pci_dev
->dev
,
794 "[%s] genwqe_user_vmap rc=%d\n", __func__
, rc
);
799 genwqe_add_pin(cfile
, dma_map
);
803 static int genwqe_unpin_mem(struct genwqe_file
*cfile
, struct genwqe_mem
*m
)
805 struct genwqe_dev
*cd
= cfile
->cd
;
806 struct dma_mapping
*dma_map
;
807 unsigned long map_addr
;
808 unsigned long map_size
;
813 map_addr
= (m
->addr
& PAGE_MASK
);
814 map_size
= round_up(m
->size
+ (m
->addr
& ~PAGE_MASK
), PAGE_SIZE
);
816 dma_map
= genwqe_search_pin(cfile
, map_addr
, map_size
, NULL
);
820 genwqe_del_pin(cfile
, dma_map
);
821 genwqe_user_vunmap(cd
, dma_map
);
827 * ddcb_cmd_cleanup() - Remove dynamically created fixup entries
829 * Only if there are any. Pinnings are not removed.
831 static int ddcb_cmd_cleanup(struct genwqe_file
*cfile
, struct ddcb_requ
*req
)
834 struct dma_mapping
*dma_map
;
835 struct genwqe_dev
*cd
= cfile
->cd
;
837 for (i
= 0; i
< DDCB_FIXUPS
; i
++) {
838 dma_map
= &req
->dma_mappings
[i
];
840 if (dma_mapping_used(dma_map
)) {
841 __genwqe_del_mapping(cfile
, dma_map
);
842 genwqe_user_vunmap(cd
, dma_map
);
844 if (req
->sgls
[i
].sgl
!= NULL
)
845 genwqe_free_sync_sgl(cd
, &req
->sgls
[i
]);
851 * ddcb_cmd_fixups() - Establish DMA fixups/sglists for user memory references
853 * Before the DDCB gets executed we need to handle the fixups. We
854 * replace the user-space addresses with DMA addresses or do
855 * additional setup work e.g. generating a scatter-gather list which
856 * is used to describe the memory referred to in the fixup.
858 static int ddcb_cmd_fixups(struct genwqe_file
*cfile
, struct ddcb_requ
*req
)
861 unsigned int asiv_offs
, i
;
862 struct genwqe_dev
*cd
= cfile
->cd
;
863 struct genwqe_ddcb_cmd
*cmd
= &req
->cmd
;
864 struct dma_mapping
*m
;
866 for (i
= 0, asiv_offs
= 0x00; asiv_offs
<= 0x58;
867 i
++, asiv_offs
+= 0x08) {
874 ats_flags
= ATS_GET_FLAGS(cmd
->ats
, asiv_offs
);
879 break; /* nothing to do here */
881 case ATS_TYPE_FLAT_RDWR
:
882 case ATS_TYPE_FLAT_RD
: {
883 u_addr
= be64_to_cpu(*((__be64
*)&cmd
->
885 u_size
= be32_to_cpu(*((__be32
*)&cmd
->
886 asiv
[asiv_offs
+ 0x08]));
889 * No data available. Ignore u_addr in this
890 * case and set addr to 0. Hardware must not
894 *((__be64
*)&cmd
->asiv
[asiv_offs
]) =
899 m
= __genwqe_search_mapping(cfile
, u_addr
, u_size
,
906 *((__be64
*)&cmd
->asiv
[asiv_offs
]) =
911 case ATS_TYPE_SGL_RDWR
:
912 case ATS_TYPE_SGL_RD
: {
915 u_addr
= be64_to_cpu(*((__be64
*)
916 &cmd
->asiv
[asiv_offs
]));
917 u_size
= be32_to_cpu(*((__be32
*)
918 &cmd
->asiv
[asiv_offs
+ 0x08]));
921 * No data available. Ignore u_addr in this
922 * case and set addr to 0. Hardware must not
923 * fetch the empty sgl.
926 *((__be64
*)&cmd
->asiv
[asiv_offs
]) =
931 m
= genwqe_search_pin(cfile
, u_addr
, u_size
, NULL
);
933 page_offs
= (u_addr
-
934 (u64
)m
->u_vaddr
)/PAGE_SIZE
;
936 m
= &req
->dma_mappings
[i
];
938 genwqe_mapping_init(m
,
939 GENWQE_MAPPING_SGL_TEMP
);
941 if (ats_flags
== ATS_TYPE_SGL_RD
)
944 rc
= genwqe_user_vmap(cd
, m
, (void *)u_addr
,
949 __genwqe_add_mapping(cfile
, m
);
953 /* create genwqe style scatter gather list */
954 rc
= genwqe_alloc_sync_sgl(cd
, &req
->sgls
[i
],
955 (void __user
*)u_addr
,
960 genwqe_setup_sgl(cd
, &req
->sgls
[i
],
961 &m
->dma_list
[page_offs
]);
963 *((__be64
*)&cmd
->asiv
[asiv_offs
]) =
964 cpu_to_be64(req
->sgls
[i
].sgl_dma_addr
);
976 ddcb_cmd_cleanup(cfile
, req
);
981 * genwqe_execute_ddcb() - Execute DDCB using userspace address fixups
983 * The code will build up the translation tables or lookup the
984 * contignous memory allocation table to find the right translations
987 static int genwqe_execute_ddcb(struct genwqe_file
*cfile
,
988 struct genwqe_ddcb_cmd
*cmd
)
991 struct genwqe_dev
*cd
= cfile
->cd
;
992 struct file
*filp
= cfile
->filp
;
993 struct ddcb_requ
*req
= container_of(cmd
, struct ddcb_requ
, cmd
);
995 rc
= ddcb_cmd_fixups(cfile
, req
);
999 rc
= __genwqe_execute_raw_ddcb(cd
, cmd
, filp
->f_flags
);
1000 ddcb_cmd_cleanup(cfile
, req
);
1004 static int do_execute_ddcb(struct genwqe_file
*cfile
,
1005 unsigned long arg
, int raw
)
1008 struct genwqe_ddcb_cmd
*cmd
;
1009 struct genwqe_dev
*cd
= cfile
->cd
;
1010 struct file
*filp
= cfile
->filp
;
1012 cmd
= ddcb_requ_alloc();
1016 if (copy_from_user(cmd
, (void __user
*)arg
, sizeof(*cmd
))) {
1017 ddcb_requ_free(cmd
);
1022 rc
= genwqe_execute_ddcb(cfile
, cmd
);
1024 rc
= __genwqe_execute_raw_ddcb(cd
, cmd
, filp
->f_flags
);
1026 /* Copy back only the modifed fields. Do not copy ASIV
1027 back since the copy got modified by the driver. */
1028 if (copy_to_user((void __user
*)arg
, cmd
,
1029 sizeof(*cmd
) - DDCB_ASIV_LENGTH
)) {
1030 ddcb_requ_free(cmd
);
1034 ddcb_requ_free(cmd
);
1039 * genwqe_ioctl() - IO control
1040 * @filp: file handle
1041 * @cmd: command identifier (passed from user)
1042 * @arg: argument (passed from user)
1046 static long genwqe_ioctl(struct file
*filp
, unsigned int cmd
,
1050 struct genwqe_file
*cfile
= (struct genwqe_file
*)filp
->private_data
;
1051 struct genwqe_dev
*cd
= cfile
->cd
;
1052 struct pci_dev
*pci_dev
= cd
->pci_dev
;
1053 struct genwqe_reg_io __user
*io
;
1057 /* Return -EIO if card hit EEH */
1058 if (pci_channel_offline(pci_dev
))
1061 if (_IOC_TYPE(cmd
) != GENWQE_IOC_CODE
)
1066 case GENWQE_GET_CARD_STATE
:
1067 put_user(cd
->card_state
, (enum genwqe_card_state __user
*)arg
);
1070 /* Register access */
1071 case GENWQE_READ_REG64
: {
1072 io
= (struct genwqe_reg_io __user
*)arg
;
1074 if (get_user(reg_offs
, &io
->num
))
1077 if ((reg_offs
>= cd
->mmio_len
) || (reg_offs
& 0x7))
1080 val
= __genwqe_readq(cd
, reg_offs
);
1081 put_user(val
, &io
->val64
);
1085 case GENWQE_WRITE_REG64
: {
1086 io
= (struct genwqe_reg_io __user
*)arg
;
1088 if (!capable(CAP_SYS_ADMIN
))
1091 if ((filp
->f_flags
& O_ACCMODE
) == O_RDONLY
)
1094 if (get_user(reg_offs
, &io
->num
))
1097 if ((reg_offs
>= cd
->mmio_len
) || (reg_offs
& 0x7))
1100 if (get_user(val
, &io
->val64
))
1103 __genwqe_writeq(cd
, reg_offs
, val
);
1107 case GENWQE_READ_REG32
: {
1108 io
= (struct genwqe_reg_io __user
*)arg
;
1110 if (get_user(reg_offs
, &io
->num
))
1113 if ((reg_offs
>= cd
->mmio_len
) || (reg_offs
& 0x3))
1116 val
= __genwqe_readl(cd
, reg_offs
);
1117 put_user(val
, &io
->val64
);
1121 case GENWQE_WRITE_REG32
: {
1122 io
= (struct genwqe_reg_io __user
*)arg
;
1124 if (!capable(CAP_SYS_ADMIN
))
1127 if ((filp
->f_flags
& O_ACCMODE
) == O_RDONLY
)
1130 if (get_user(reg_offs
, &io
->num
))
1133 if ((reg_offs
>= cd
->mmio_len
) || (reg_offs
& 0x3))
1136 if (get_user(val
, &io
->val64
))
1139 __genwqe_writel(cd
, reg_offs
, val
);
1143 /* Flash update/reading */
1144 case GENWQE_SLU_UPDATE
: {
1145 struct genwqe_bitstream load
;
1147 if (!genwqe_is_privileged(cd
))
1150 if ((filp
->f_flags
& O_ACCMODE
) == O_RDONLY
)
1153 if (copy_from_user(&load
, (void __user
*)arg
,
1157 rc
= do_flash_update(cfile
, &load
);
1159 if (copy_to_user((void __user
*)arg
, &load
, sizeof(load
)))
1165 case GENWQE_SLU_READ
: {
1166 struct genwqe_bitstream load
;
1168 if (!genwqe_is_privileged(cd
))
1171 if (genwqe_flash_readback_fails(cd
))
1172 return -ENOSPC
; /* known to fail for old versions */
1174 if (copy_from_user(&load
, (void __user
*)arg
, sizeof(load
)))
1177 rc
= do_flash_read(cfile
, &load
);
1179 if (copy_to_user((void __user
*)arg
, &load
, sizeof(load
)))
1185 /* memory pinning and unpinning */
1186 case GENWQE_PIN_MEM
: {
1187 struct genwqe_mem m
;
1189 if (copy_from_user(&m
, (void __user
*)arg
, sizeof(m
)))
1192 return genwqe_pin_mem(cfile
, &m
);
1195 case GENWQE_UNPIN_MEM
: {
1196 struct genwqe_mem m
;
1198 if (copy_from_user(&m
, (void __user
*)arg
, sizeof(m
)))
1201 return genwqe_unpin_mem(cfile
, &m
);
1204 /* launch an DDCB and wait for completion */
1205 case GENWQE_EXECUTE_DDCB
:
1206 return do_execute_ddcb(cfile
, arg
, 0);
1208 case GENWQE_EXECUTE_RAW_DDCB
: {
1210 if (!capable(CAP_SYS_ADMIN
))
1213 return do_execute_ddcb(cfile
, arg
, 1);
1223 #if defined(CONFIG_COMPAT)
1225 * genwqe_compat_ioctl() - Compatibility ioctl
1227 * Called whenever a 32-bit process running under a 64-bit kernel
1228 * performs an ioctl on /dev/genwqe<n>_card.
1230 * @filp: file pointer.
1232 * @arg: user argument.
1233 * Return: zero on success or negative number on failure.
1235 static long genwqe_compat_ioctl(struct file
*filp
, unsigned int cmd
,
1238 return genwqe_ioctl(filp
, cmd
, arg
);
1240 #endif /* defined(CONFIG_COMPAT) */
1242 static const struct file_operations genwqe_fops
= {
1243 .owner
= THIS_MODULE
,
1244 .open
= genwqe_open
,
1245 .fasync
= genwqe_fasync
,
1246 .mmap
= genwqe_mmap
,
1247 .unlocked_ioctl
= genwqe_ioctl
,
1248 #if defined(CONFIG_COMPAT)
1249 .compat_ioctl
= genwqe_compat_ioctl
,
1251 .release
= genwqe_release
,
1254 static int genwqe_device_initialized(struct genwqe_dev
*cd
)
1256 return cd
->dev
!= NULL
;
1260 * genwqe_device_create() - Create and configure genwqe char device
1261 * @cd: genwqe device descriptor
1263 * This function must be called before we create any more genwqe
1264 * character devices, because it is allocating the major and minor
1265 * number which are supposed to be used by the client drivers.
1267 int genwqe_device_create(struct genwqe_dev
*cd
)
1270 struct pci_dev
*pci_dev
= cd
->pci_dev
;
1273 * Here starts the individual setup per client. It must
1274 * initialize its own cdev data structure with its own fops.
1275 * The appropriate devnum needs to be created. The ranges must
1278 rc
= alloc_chrdev_region(&cd
->devnum_genwqe
, 0,
1279 GENWQE_MAX_MINOR
, GENWQE_DEVNAME
);
1281 dev_err(&pci_dev
->dev
, "err: alloc_chrdev_region failed\n");
1285 cdev_init(&cd
->cdev_genwqe
, &genwqe_fops
);
1286 cd
->cdev_genwqe
.owner
= THIS_MODULE
;
1288 rc
= cdev_add(&cd
->cdev_genwqe
, cd
->devnum_genwqe
, 1);
1290 dev_err(&pci_dev
->dev
, "err: cdev_add failed\n");
1295 * Finally the device in /dev/... must be created. The rule is
1296 * to use card%d_clientname for each created device.
1298 cd
->dev
= device_create_with_groups(cd
->class_genwqe
,
1300 cd
->devnum_genwqe
, cd
,
1301 genwqe_attribute_groups
,
1302 GENWQE_DEVNAME
"%u_card",
1304 if (IS_ERR(cd
->dev
)) {
1305 rc
= PTR_ERR(cd
->dev
);
1309 rc
= genwqe_init_debugfs(cd
);
1316 device_destroy(cd
->class_genwqe
, cd
->devnum_genwqe
);
1318 cdev_del(&cd
->cdev_genwqe
);
1320 unregister_chrdev_region(cd
->devnum_genwqe
, GENWQE_MAX_MINOR
);
1326 static int genwqe_inform_and_stop_processes(struct genwqe_dev
*cd
)
1330 struct pci_dev
*pci_dev
= cd
->pci_dev
;
1332 if (!genwqe_open_files(cd
))
1335 dev_warn(&pci_dev
->dev
, "[%s] send SIGIO and wait ...\n", __func__
);
1337 rc
= genwqe_kill_fasync(cd
, SIGIO
);
1339 /* give kill_timeout seconds to close file descriptors ... */
1340 for (i
= 0; (i
< GENWQE_KILL_TIMEOUT
) &&
1341 genwqe_open_files(cd
); i
++) {
1342 dev_info(&pci_dev
->dev
, " %d sec ...", i
);
1348 /* if no open files we can safely continue, else ... */
1349 if (!genwqe_open_files(cd
))
1352 dev_warn(&pci_dev
->dev
,
1353 "[%s] send SIGKILL and wait ...\n", __func__
);
1355 rc
= genwqe_force_sig(cd
, SIGKILL
); /* force terminate */
1357 /* Give kill_timout more seconds to end processes */
1358 for (i
= 0; (i
< GENWQE_KILL_TIMEOUT
) &&
1359 genwqe_open_files(cd
); i
++) {
1360 dev_warn(&pci_dev
->dev
, " %d sec ...", i
);
1371 * genwqe_device_remove() - Remove genwqe's char device
1373 * This function must be called after the client devices are removed
1374 * because it will free the major/minor number range for the genwqe
1377 * This function must be robust enough to be called twice.
1379 int genwqe_device_remove(struct genwqe_dev
*cd
)
1382 struct pci_dev
*pci_dev
= cd
->pci_dev
;
1384 if (!genwqe_device_initialized(cd
))
1387 genwqe_inform_and_stop_processes(cd
);
1390 * We currently do wait until all filedescriptors are
1391 * closed. This leads to a problem when we abort the
1392 * application which will decrease this reference from
1393 * 1/unused to 0/illegal and not from 2/used 1/empty.
1395 rc
= kref_read(&cd
->cdev_genwqe
.kobj
.kref
);
1397 dev_err(&pci_dev
->dev
,
1398 "[%s] err: cdev_genwqe...refcount=%d\n", __func__
, rc
);
1399 panic("Fatal err: cannot free resources with pending references!");
1402 genqwe_exit_debugfs(cd
);
1403 device_destroy(cd
->class_genwqe
, cd
->devnum_genwqe
);
1404 cdev_del(&cd
->cdev_genwqe
);
1405 unregister_chrdev_region(cd
->devnum_genwqe
, GENWQE_MAX_MINOR
);