2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
7 * Copyright (C) 2015 EMC Corporation. All Rights Reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
20 * Copyright (C) 2015 EMC Corporation. All Rights Reserved.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
26 * * Redistributions of source code must retain the above copyright
27 * notice, this list of conditions and the following disclaimer.
28 * * Redistributions in binary form must reproduce the above copy
29 * notice, this list of conditions and the following disclaimer in
30 * the documentation and/or other materials provided with the
32 * * Neither the name of Intel Corporation nor the names of its
33 * contributors may be used to endorse or promote products derived
34 * from this software without specific prior written permission.
36 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
37 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
38 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
39 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
40 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
43 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
44 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
45 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
46 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48 * PCIe NTB Linux driver
50 * Contact Information:
51 * Allen Hubbe <Allen.Hubbe@emc.com>
54 #include <linux/device.h>
55 #include <linux/kernel.h>
56 #include <linux/module.h>
58 #include <linux/ntb.h>
59 #include <linux/pci.h>
61 #define DRIVER_NAME "ntb"
62 #define DRIVER_DESCRIPTION "PCIe NTB Driver Framework"
64 #define DRIVER_LICENSE "Dual BSD/GPL"
65 #define DRIVER_VERSION "1.0"
66 #define DRIVER_RELDATE "24 March 2015"
67 #define DRIVER_AUTHOR "Allen Hubbe <Allen.Hubbe@emc.com>"
69 MODULE_LICENSE(DRIVER_LICENSE
);
70 MODULE_VERSION(DRIVER_VERSION
);
71 MODULE_AUTHOR(DRIVER_AUTHOR
);
72 MODULE_DESCRIPTION(DRIVER_DESCRIPTION
);
74 static struct bus_type ntb_bus
;
75 static void ntb_dev_release(struct device
*dev
);
77 int __ntb_register_client(struct ntb_client
*client
, struct module
*mod
,
82 if (!ntb_client_ops_is_valid(&client
->ops
))
85 memset(&client
->drv
, 0, sizeof(client
->drv
));
86 client
->drv
.bus
= &ntb_bus
;
87 client
->drv
.name
= mod_name
;
88 client
->drv
.owner
= mod
;
90 return driver_register(&client
->drv
);
92 EXPORT_SYMBOL(__ntb_register_client
);
94 void ntb_unregister_client(struct ntb_client
*client
)
96 driver_unregister(&client
->drv
);
98 EXPORT_SYMBOL(ntb_unregister_client
);
100 int ntb_register_device(struct ntb_dev
*ntb
)
108 if (!ntb_dev_ops_is_valid(ntb
->ops
))
111 init_completion(&ntb
->released
);
113 memset(&ntb
->dev
, 0, sizeof(ntb
->dev
));
114 ntb
->dev
.bus
= &ntb_bus
;
115 ntb
->dev
.parent
= &ntb
->pdev
->dev
;
116 ntb
->dev
.release
= ntb_dev_release
;
117 dev_set_name(&ntb
->dev
, "%s", pci_name(ntb
->pdev
));
121 spin_lock_init(&ntb
->ctx_lock
);
123 return device_register(&ntb
->dev
);
125 EXPORT_SYMBOL(ntb_register_device
);
127 void ntb_unregister_device(struct ntb_dev
*ntb
)
129 device_unregister(&ntb
->dev
);
130 wait_for_completion(&ntb
->released
);
132 EXPORT_SYMBOL(ntb_unregister_device
);
134 int ntb_set_ctx(struct ntb_dev
*ntb
, void *ctx
,
135 const struct ntb_ctx_ops
*ctx_ops
)
137 unsigned long irqflags
;
139 if (!ntb_ctx_ops_is_valid(ctx_ops
))
144 spin_lock_irqsave(&ntb
->ctx_lock
, irqflags
);
147 ntb
->ctx_ops
= ctx_ops
;
149 spin_unlock_irqrestore(&ntb
->ctx_lock
, irqflags
);
153 EXPORT_SYMBOL(ntb_set_ctx
);
155 void ntb_clear_ctx(struct ntb_dev
*ntb
)
157 unsigned long irqflags
;
159 spin_lock_irqsave(&ntb
->ctx_lock
, irqflags
);
164 spin_unlock_irqrestore(&ntb
->ctx_lock
, irqflags
);
166 EXPORT_SYMBOL(ntb_clear_ctx
);
168 void ntb_link_event(struct ntb_dev
*ntb
)
170 unsigned long irqflags
;
172 spin_lock_irqsave(&ntb
->ctx_lock
, irqflags
);
174 if (ntb
->ctx_ops
&& ntb
->ctx_ops
->link_event
)
175 ntb
->ctx_ops
->link_event(ntb
->ctx
);
177 spin_unlock_irqrestore(&ntb
->ctx_lock
, irqflags
);
179 EXPORT_SYMBOL(ntb_link_event
);
181 void ntb_db_event(struct ntb_dev
*ntb
, int vector
)
183 unsigned long irqflags
;
185 spin_lock_irqsave(&ntb
->ctx_lock
, irqflags
);
187 if (ntb
->ctx_ops
&& ntb
->ctx_ops
->db_event
)
188 ntb
->ctx_ops
->db_event(ntb
->ctx
, vector
);
190 spin_unlock_irqrestore(&ntb
->ctx_lock
, irqflags
);
192 EXPORT_SYMBOL(ntb_db_event
);
194 static int ntb_probe(struct device
*dev
)
197 struct ntb_client
*client
;
202 client
= drv_ntb_client(dev
->driver
);
204 rc
= client
->ops
.probe(client
, ntb
);
211 static int ntb_remove(struct device
*dev
)
214 struct ntb_client
*client
;
218 client
= drv_ntb_client(dev
->driver
);
220 client
->ops
.remove(client
, ntb
);
227 static void ntb_dev_release(struct device
*dev
)
229 struct ntb_dev
*ntb
= dev_ntb(dev
);
231 complete(&ntb
->released
);
234 static struct bus_type ntb_bus
= {
237 .remove
= ntb_remove
,
240 static int __init
ntb_driver_init(void)
242 return bus_register(&ntb_bus
);
244 module_init(ntb_driver_init
);
246 static void __exit
ntb_driver_exit(void)
248 bus_unregister(&ntb_bus
);
250 module_exit(ntb_driver_exit
);