1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright IBM Corp. 2018
7 #define KMSG_COMPONENT "ism"
8 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/interrupt.h>
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/ctype.h>
16 #include <linux/processor.h>
20 MODULE_DESCRIPTION("ISM driver for s390");
21 MODULE_LICENSE("GPL");
23 #define PCI_DEVICE_ID_IBM_ISM 0x04ED
24 #define DRV_NAME "ism"
26 static const struct pci_device_id ism_device_table[] = {
27 { PCI_VDEVICE(IBM, PCI_DEVICE_ID_IBM_ISM), 0 },
30 MODULE_DEVICE_TABLE(pci, ism_device_table);
32 static debug_info_t *ism_debug_info;
33 static const struct smcd_ops ism_ops;
35 #define NO_CLIENT 0xff /* must be >= MAX_CLIENTS */
36 static struct ism_client *clients[MAX_CLIENTS]; /* use an array rather than */
37 /* a list for fast mapping */
39 static DEFINE_SPINLOCK(clients_lock);
41 struct list_head list;
42 struct mutex mutex; /* protects ism device list */
45 static struct ism_dev_list ism_dev_list = {
46 .list = LIST_HEAD_INIT(ism_dev_list.list),
47 .mutex = __MUTEX_INITIALIZER(ism_dev_list.mutex),
50 int ism_register_client(struct ism_client *client)
56 mutex_lock(&ism_dev_list.mutex);
57 spin_lock_irqsave(&clients_lock, flags);
58 for (i = 0; i < MAX_CLIENTS; ++i) {
68 spin_unlock_irqrestore(&clients_lock, flags);
69 if (i < MAX_CLIENTS) {
70 /* initialize with all devices that we got so far */
71 list_for_each_entry(ism, &ism_dev_list.list, list) {
76 mutex_unlock(&ism_dev_list.mutex);
80 EXPORT_SYMBOL_GPL(ism_register_client);
82 int ism_unregister_client(struct ism_client *client)
88 mutex_lock(&ism_dev_list.mutex);
89 spin_lock_irqsave(&clients_lock, flags);
90 clients[client->id] = NULL;
91 if (client->id + 1 == max_client)
93 spin_unlock_irqrestore(&clients_lock, flags);
94 list_for_each_entry(ism, &ism_dev_list.list, list) {
95 for (int i = 0; i < ISM_NR_DMBS; ++i) {
96 if (ism->sba_client_arr[i] == client->id) {
97 pr_err("%s: attempt to unregister client '%s'"
98 "with registered dmb(s)\n", __func__,
106 mutex_unlock(&ism_dev_list.mutex);
110 EXPORT_SYMBOL_GPL(ism_unregister_client);
112 static int ism_cmd(struct ism_dev *ism, void *cmd)
114 struct ism_req_hdr *req = cmd;
115 struct ism_resp_hdr *resp = cmd;
117 __ism_write_cmd(ism, req + 1, sizeof(*req), req->len - sizeof(*req));
118 __ism_write_cmd(ism, req, 0, sizeof(*req));
120 WRITE_ONCE(resp->ret, ISM_ERROR);
122 __ism_read_cmd(ism, resp, 0, sizeof(*resp));
124 debug_text_event(ism_debug_info, 0, "cmd failure");
125 debug_event(ism_debug_info, 0, resp, sizeof(*resp));
128 __ism_read_cmd(ism, resp + 1, sizeof(*resp), resp->len - sizeof(*resp));
133 static int ism_cmd_simple(struct ism_dev *ism, u32 cmd_code)
135 union ism_cmd_simple cmd;
137 memset(&cmd, 0, sizeof(cmd));
138 cmd.request.hdr.cmd = cmd_code;
139 cmd.request.hdr.len = sizeof(cmd.request);
141 return ism_cmd(ism, &cmd);
144 static int query_info(struct ism_dev *ism)
148 memset(&cmd, 0, sizeof(cmd));
149 cmd.request.hdr.cmd = ISM_QUERY_INFO;
150 cmd.request.hdr.len = sizeof(cmd.request);
152 if (ism_cmd(ism, &cmd))
155 debug_text_event(ism_debug_info, 3, "query info");
156 debug_event(ism_debug_info, 3, &cmd.response, sizeof(cmd.response));
161 static int register_sba(struct ism_dev *ism)
163 union ism_reg_sba cmd;
164 dma_addr_t dma_handle;
167 sba = dma_alloc_coherent(&ism->pdev->dev, PAGE_SIZE, &dma_handle,
172 memset(&cmd, 0, sizeof(cmd));
173 cmd.request.hdr.cmd = ISM_REG_SBA;
174 cmd.request.hdr.len = sizeof(cmd.request);
175 cmd.request.sba = dma_handle;
177 if (ism_cmd(ism, &cmd)) {
178 dma_free_coherent(&ism->pdev->dev, PAGE_SIZE, sba, dma_handle);
183 ism->sba_dma_addr = dma_handle;
188 static int register_ieq(struct ism_dev *ism)
190 union ism_reg_ieq cmd;
191 dma_addr_t dma_handle;
194 ieq = dma_alloc_coherent(&ism->pdev->dev, PAGE_SIZE, &dma_handle,
199 memset(&cmd, 0, sizeof(cmd));
200 cmd.request.hdr.cmd = ISM_REG_IEQ;
201 cmd.request.hdr.len = sizeof(cmd.request);
202 cmd.request.ieq = dma_handle;
203 cmd.request.len = sizeof(*ieq);
205 if (ism_cmd(ism, &cmd)) {
206 dma_free_coherent(&ism->pdev->dev, PAGE_SIZE, ieq, dma_handle);
212 ism->ieq_dma_addr = dma_handle;
217 static int unregister_sba(struct ism_dev *ism)
224 ret = ism_cmd_simple(ism, ISM_UNREG_SBA);
225 if (ret && ret != ISM_ERROR)
228 dma_free_coherent(&ism->pdev->dev, PAGE_SIZE,
229 ism->sba, ism->sba_dma_addr);
232 ism->sba_dma_addr = 0;
237 static int unregister_ieq(struct ism_dev *ism)
244 ret = ism_cmd_simple(ism, ISM_UNREG_IEQ);
245 if (ret && ret != ISM_ERROR)
248 dma_free_coherent(&ism->pdev->dev, PAGE_SIZE,
249 ism->ieq, ism->ieq_dma_addr);
252 ism->ieq_dma_addr = 0;
257 static int ism_read_local_gid(struct ism_dev *ism)
259 union ism_read_gid cmd;
262 memset(&cmd, 0, sizeof(cmd));
263 cmd.request.hdr.cmd = ISM_READ_GID;
264 cmd.request.hdr.len = sizeof(cmd.request);
266 ret = ism_cmd(ism, &cmd);
270 ism->local_gid = cmd.response.gid;
275 static int ism_query_rgid(struct ism_dev *ism, u64 rgid, u32 vid_valid,
278 union ism_query_rgid cmd;
280 memset(&cmd, 0, sizeof(cmd));
281 cmd.request.hdr.cmd = ISM_QUERY_RGID;
282 cmd.request.hdr.len = sizeof(cmd.request);
284 cmd.request.rgid = rgid;
285 cmd.request.vlan_valid = vid_valid;
286 cmd.request.vlan_id = vid;
288 return ism_cmd(ism, &cmd);
291 static void ism_free_dmb(struct ism_dev *ism, struct ism_dmb *dmb)
293 clear_bit(dmb->sba_idx, ism->sba_bitmap);
294 dma_free_coherent(&ism->pdev->dev, dmb->dmb_len,
295 dmb->cpu_addr, dmb->dma_addr);
298 static int ism_alloc_dmb(struct ism_dev *ism, struct ism_dmb *dmb)
302 if (PAGE_ALIGN(dmb->dmb_len) > dma_get_max_seg_size(&ism->pdev->dev))
306 bit = find_next_zero_bit(ism->sba_bitmap, ISM_NR_DMBS,
308 if (bit == ISM_NR_DMBS)
313 if (dmb->sba_idx < ISM_DMB_BIT_OFFSET ||
314 test_and_set_bit(dmb->sba_idx, ism->sba_bitmap))
317 dmb->cpu_addr = dma_alloc_coherent(&ism->pdev->dev, dmb->dmb_len,
319 GFP_KERNEL | __GFP_NOWARN |
320 __GFP_NOMEMALLOC | __GFP_NORETRY);
322 clear_bit(dmb->sba_idx, ism->sba_bitmap);
324 return dmb->cpu_addr ? 0 : -ENOMEM;
327 int ism_register_dmb(struct ism_dev *ism, struct ism_dmb *dmb,
328 struct ism_client *client)
330 union ism_reg_dmb cmd;
333 ret = ism_alloc_dmb(ism, dmb);
337 memset(&cmd, 0, sizeof(cmd));
338 cmd.request.hdr.cmd = ISM_REG_DMB;
339 cmd.request.hdr.len = sizeof(cmd.request);
341 cmd.request.dmb = dmb->dma_addr;
342 cmd.request.dmb_len = dmb->dmb_len;
343 cmd.request.sba_idx = dmb->sba_idx;
344 cmd.request.vlan_valid = dmb->vlan_valid;
345 cmd.request.vlan_id = dmb->vlan_id;
346 cmd.request.rgid = dmb->rgid;
348 ret = ism_cmd(ism, &cmd);
350 ism_free_dmb(ism, dmb);
353 dmb->dmb_tok = cmd.response.dmb_tok;
354 ism->sba_client_arr[dmb->sba_idx - ISM_DMB_BIT_OFFSET] = client->id;
358 EXPORT_SYMBOL_GPL(ism_register_dmb);
360 int ism_unregister_dmb(struct ism_dev *ism, struct ism_dmb *dmb)
362 union ism_unreg_dmb cmd;
365 memset(&cmd, 0, sizeof(cmd));
366 cmd.request.hdr.cmd = ISM_UNREG_DMB;
367 cmd.request.hdr.len = sizeof(cmd.request);
369 cmd.request.dmb_tok = dmb->dmb_tok;
371 ism->sba_client_arr[dmb->sba_idx - ISM_DMB_BIT_OFFSET] = NO_CLIENT;
373 ret = ism_cmd(ism, &cmd);
374 if (ret && ret != ISM_ERROR)
377 ism_free_dmb(ism, dmb);
381 EXPORT_SYMBOL_GPL(ism_unregister_dmb);
383 static int ism_add_vlan_id(struct ism_dev *ism, u64 vlan_id)
385 union ism_set_vlan_id cmd;
387 memset(&cmd, 0, sizeof(cmd));
388 cmd.request.hdr.cmd = ISM_ADD_VLAN_ID;
389 cmd.request.hdr.len = sizeof(cmd.request);
391 cmd.request.vlan_id = vlan_id;
393 return ism_cmd(ism, &cmd);
396 static int ism_del_vlan_id(struct ism_dev *ism, u64 vlan_id)
398 union ism_set_vlan_id cmd;
400 memset(&cmd, 0, sizeof(cmd));
401 cmd.request.hdr.cmd = ISM_DEL_VLAN_ID;
402 cmd.request.hdr.len = sizeof(cmd.request);
404 cmd.request.vlan_id = vlan_id;
406 return ism_cmd(ism, &cmd);
409 static int ism_signal_ieq(struct ism_dev *ism, u64 rgid, u32 trigger_irq,
410 u32 event_code, u64 info)
412 union ism_sig_ieq cmd;
414 memset(&cmd, 0, sizeof(cmd));
415 cmd.request.hdr.cmd = ISM_SIGNAL_IEQ;
416 cmd.request.hdr.len = sizeof(cmd.request);
418 cmd.request.rgid = rgid;
419 cmd.request.trigger_irq = trigger_irq;
420 cmd.request.event_code = event_code;
421 cmd.request.info = info;
423 return ism_cmd(ism, &cmd);
426 static unsigned int max_bytes(unsigned int start, unsigned int len,
427 unsigned int boundary)
429 return min(boundary - (start & (boundary - 1)), len);
432 int ism_move(struct ism_dev *ism, u64 dmb_tok, unsigned int idx, bool sf,
433 unsigned int offset, void *data, unsigned int size)
440 bytes = max_bytes(offset, size, PAGE_SIZE);
441 dmb_req = ISM_CREATE_REQ(dmb_tok, idx, size == bytes ? sf : 0,
444 ret = __ism_move(ism, dmb_req, data, bytes);
455 EXPORT_SYMBOL_GPL(ism_move);
457 static struct ism_systemeid SYSTEM_EID = {
458 .seid_string = "IBM-SYSZ-ISMSEID00000000",
459 .serial_number = "0000",
463 static void ism_create_system_eid(void)
470 ident_tail = (u16)(id.ident & ISM_IDENT_MASK);
471 snprintf(tmp, 5, "%04X", ident_tail);
472 memcpy(&SYSTEM_EID.serial_number, tmp, 4);
473 snprintf(tmp, 5, "%04X", id.machine);
474 memcpy(&SYSTEM_EID.type, tmp, 4);
477 u8 *ism_get_seid(void)
479 return SYSTEM_EID.seid_string;
481 EXPORT_SYMBOL_GPL(ism_get_seid);
483 static u16 ism_get_chid(struct ism_dev *ism)
485 if (!ism || !ism->pdev)
488 return to_zpci(ism->pdev)->pchid;
491 static void ism_handle_event(struct ism_dev *ism)
493 struct ism_event *entry;
496 while ((ism->ieq_idx + 1) != READ_ONCE(ism->ieq->header.idx)) {
497 if (++(ism->ieq_idx) == ARRAY_SIZE(ism->ieq->entry))
500 entry = &ism->ieq->entry[ism->ieq_idx];
501 debug_event(ism_debug_info, 2, entry, sizeof(*entry));
502 spin_lock(&clients_lock);
503 for (i = 0; i < max_client; ++i)
505 clients[i]->handle_event(ism, entry);
506 spin_unlock(&clients_lock);
510 static irqreturn_t ism_handle_irq(int irq, void *data)
512 struct ism_dev *ism = data;
513 struct ism_client *clt;
514 unsigned long bit, end;
518 bv = (void *) &ism->sba->dmb_bits[ISM_DMB_WORD_OFFSET];
519 end = sizeof(ism->sba->dmb_bits) * BITS_PER_BYTE - ISM_DMB_BIT_OFFSET;
521 spin_lock(&ism->lock);
525 bit = find_next_bit_inv(bv, end, bit);
529 clear_bit_inv(bit, bv);
530 dmbemask = ism->sba->dmbe_mask[bit + ISM_DMB_BIT_OFFSET];
531 ism->sba->dmbe_mask[bit + ISM_DMB_BIT_OFFSET] = 0;
533 clt = clients[ism->sba_client_arr[bit]];
534 clt->handle_irq(ism, bit + ISM_DMB_BIT_OFFSET, dmbemask);
540 ism_handle_event(ism);
542 spin_unlock(&ism->lock);
546 static u64 ism_get_local_gid(struct ism_dev *ism)
548 return ism->local_gid;
551 static void ism_dev_add_work_func(struct work_struct *work)
553 struct ism_client *client = container_of(work, struct ism_client,
556 client->add(client->tgt_ism);
557 atomic_dec(&client->tgt_ism->add_dev_cnt);
558 wake_up(&client->tgt_ism->waitq);
561 static int ism_dev_init(struct ism_dev *ism)
563 struct pci_dev *pdev = ism->pdev;
567 ret = pci_alloc_irq_vectors(pdev, 1, 1, PCI_IRQ_MSI);
571 ism->sba_client_arr = kzalloc(ISM_NR_DMBS, GFP_KERNEL);
572 if (!ism->sba_client_arr)
574 memset(ism->sba_client_arr, NO_CLIENT, ISM_NR_DMBS);
576 ret = request_irq(pci_irq_vector(pdev, 0), ism_handle_irq, 0,
577 pci_name(pdev), ism);
579 goto free_client_arr;
581 ret = register_sba(ism);
585 ret = register_ieq(ism);
589 ret = ism_read_local_gid(ism);
593 if (!ism_add_vlan_id(ism, ISM_RESERVED_VLANID))
594 /* hardware is V2 capable */
595 ism_create_system_eid();
597 init_waitqueue_head(&ism->waitq);
598 atomic_set(&ism->free_clients_cnt, 0);
599 atomic_set(&ism->add_dev_cnt, 0);
601 wait_event(ism->waitq, !atomic_read(&ism->add_dev_cnt));
602 spin_lock_irqsave(&clients_lock, flags);
603 for (i = 0; i < max_client; ++i)
605 INIT_WORK(&clients[i]->add_work,
606 ism_dev_add_work_func);
607 clients[i]->tgt_ism = ism;
608 atomic_inc(&ism->add_dev_cnt);
609 schedule_work(&clients[i]->add_work);
611 spin_unlock_irqrestore(&clients_lock, flags);
613 wait_event(ism->waitq, !atomic_read(&ism->add_dev_cnt));
615 mutex_lock(&ism_dev_list.mutex);
616 list_add(&ism->list, &ism_dev_list.list);
617 mutex_unlock(&ism_dev_list.mutex);
627 free_irq(pci_irq_vector(pdev, 0), ism);
629 kfree(ism->sba_client_arr);
631 pci_free_irq_vectors(pdev);
636 static int ism_probe(struct pci_dev *pdev, const struct pci_device_id *id)
641 ism = kzalloc(sizeof(*ism), GFP_KERNEL);
645 spin_lock_init(&ism->lock);
646 dev_set_drvdata(&pdev->dev, ism);
648 ism->dev.parent = &pdev->dev;
649 device_initialize(&ism->dev);
650 dev_set_name(&ism->dev, dev_name(&pdev->dev));
651 ret = device_add(&ism->dev);
655 ret = pci_enable_device_mem(pdev);
659 ret = pci_request_mem_regions(pdev, DRV_NAME);
663 ret = dma_set_mask(&pdev->dev, DMA_BIT_MASK(64));
667 dma_set_seg_boundary(&pdev->dev, SZ_1M - 1);
668 dma_set_max_seg_size(&pdev->dev, SZ_1M);
669 pci_set_master(pdev);
671 ret = ism_dev_init(ism);
678 pci_release_mem_regions(pdev);
680 pci_disable_device(pdev);
682 device_del(&ism->dev);
684 dev_set_drvdata(&pdev->dev, NULL);
690 static void ism_dev_remove_work_func(struct work_struct *work)
692 struct ism_client *client = container_of(work, struct ism_client,
695 client->remove(client->tgt_ism);
696 atomic_dec(&client->tgt_ism->free_clients_cnt);
697 wake_up(&client->tgt_ism->waitq);
700 /* Callers must hold ism_dev_list.mutex */
701 static void ism_dev_exit(struct ism_dev *ism)
703 struct pci_dev *pdev = ism->pdev;
707 wait_event(ism->waitq, !atomic_read(&ism->free_clients_cnt));
708 spin_lock_irqsave(&clients_lock, flags);
709 for (i = 0; i < max_client; ++i)
711 INIT_WORK(&clients[i]->remove_work,
712 ism_dev_remove_work_func);
713 clients[i]->tgt_ism = ism;
714 atomic_inc(&ism->free_clients_cnt);
715 schedule_work(&clients[i]->remove_work);
717 spin_unlock_irqrestore(&clients_lock, flags);
719 wait_event(ism->waitq, !atomic_read(&ism->free_clients_cnt));
721 if (SYSTEM_EID.serial_number[0] != '0' ||
722 SYSTEM_EID.type[0] != '0')
723 ism_del_vlan_id(ism, ISM_RESERVED_VLANID);
726 free_irq(pci_irq_vector(pdev, 0), ism);
727 kfree(ism->sba_client_arr);
728 pci_free_irq_vectors(pdev);
729 list_del_init(&ism->list);
732 static void ism_remove(struct pci_dev *pdev)
734 struct ism_dev *ism = dev_get_drvdata(&pdev->dev);
736 mutex_lock(&ism_dev_list.mutex);
738 mutex_unlock(&ism_dev_list.mutex);
740 pci_release_mem_regions(pdev);
741 pci_disable_device(pdev);
742 device_del(&ism->dev);
743 dev_set_drvdata(&pdev->dev, NULL);
747 static struct pci_driver ism_driver = {
749 .id_table = ism_device_table,
751 .remove = ism_remove,
754 static int __init ism_init(void)
758 ism_debug_info = debug_register("ism", 2, 1, 16);
762 memset(clients, 0, sizeof(clients));
764 debug_register_view(ism_debug_info, &debug_hex_ascii_view);
765 ret = pci_register_driver(&ism_driver);
767 debug_unregister(ism_debug_info);
772 static void __exit ism_exit(void)
776 mutex_lock(&ism_dev_list.mutex);
777 list_for_each_entry(ism, &ism_dev_list.list, list) {
780 mutex_unlock(&ism_dev_list.mutex);
782 pci_unregister_driver(&ism_driver);
783 debug_unregister(ism_debug_info);
786 module_init(ism_init);
787 module_exit(ism_exit);
789 /*************************** SMC-D Implementation *****************************/
791 #if IS_ENABLED(CONFIG_SMC)
792 static int smcd_query_rgid(struct smcd_dev *smcd, u64 rgid, u32 vid_valid,
795 return ism_query_rgid(smcd->priv, rgid, vid_valid, vid);
798 static int smcd_register_dmb(struct smcd_dev *smcd, struct smcd_dmb *dmb,
799 struct ism_client *client)
801 return ism_register_dmb(smcd->priv, (struct ism_dmb *)dmb, client);
804 static int smcd_unregister_dmb(struct smcd_dev *smcd, struct smcd_dmb *dmb)
806 return ism_unregister_dmb(smcd->priv, (struct ism_dmb *)dmb);
809 static int smcd_add_vlan_id(struct smcd_dev *smcd, u64 vlan_id)
811 return ism_add_vlan_id(smcd->priv, vlan_id);
814 static int smcd_del_vlan_id(struct smcd_dev *smcd, u64 vlan_id)
816 return ism_del_vlan_id(smcd->priv, vlan_id);
819 static int smcd_set_vlan_required(struct smcd_dev *smcd)
821 return ism_cmd_simple(smcd->priv, ISM_SET_VLAN);
824 static int smcd_reset_vlan_required(struct smcd_dev *smcd)
826 return ism_cmd_simple(smcd->priv, ISM_RESET_VLAN);
829 static int smcd_signal_ieq(struct smcd_dev *smcd, u64 rgid, u32 trigger_irq,
830 u32 event_code, u64 info)
832 return ism_signal_ieq(smcd->priv, rgid, trigger_irq, event_code, info);
835 static int smcd_move(struct smcd_dev *smcd, u64 dmb_tok, unsigned int idx,
836 bool sf, unsigned int offset, void *data,
839 return ism_move(smcd->priv, dmb_tok, idx, sf, offset, data, size);
842 static int smcd_supports_v2(void)
844 return SYSTEM_EID.serial_number[0] != '0' ||
845 SYSTEM_EID.type[0] != '0';
848 static u64 smcd_get_local_gid(struct smcd_dev *smcd)
850 return ism_get_local_gid(smcd->priv);
853 static u16 smcd_get_chid(struct smcd_dev *smcd)
855 return ism_get_chid(smcd->priv);
858 static inline struct device *smcd_get_dev(struct smcd_dev *dev)
860 struct ism_dev *ism = dev->priv;
865 static const struct smcd_ops ism_ops = {
866 .query_remote_gid = smcd_query_rgid,
867 .register_dmb = smcd_register_dmb,
868 .unregister_dmb = smcd_unregister_dmb,
869 .add_vlan_id = smcd_add_vlan_id,
870 .del_vlan_id = smcd_del_vlan_id,
871 .set_vlan_required = smcd_set_vlan_required,
872 .reset_vlan_required = smcd_reset_vlan_required,
873 .signal_event = smcd_signal_ieq,
874 .move_data = smcd_move,
875 .supports_v2 = smcd_supports_v2,
876 .get_system_eid = ism_get_seid,
877 .get_local_gid = smcd_get_local_gid,
878 .get_chid = smcd_get_chid,
879 .get_dev = smcd_get_dev,
882 const struct smcd_ops *ism_get_smcd_ops(void)
886 EXPORT_SYMBOL_GPL(ism_get_smcd_ops);