linux/drivers/ntb/core.c

/*
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 *   redistributing this file, you may do so under either license.
 *
 *   GPL LICENSE SUMMARY
 *
 *   Copyright (C) 2015 EMC Corporation. All Rights Reserved.
 *   Copyright (C) 2016 T-Platforms. All Rights Reserved.
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of version 2 of the GNU General Public License as
 *   published by the Free Software Foundation.
 *
 *   This program is distributed in the hope that it will be useful, but
 *   WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *   General Public License for more details.
 *
 *   BSD LICENSE
 *
 *   Copyright (C) 2015 EMC Corporation. All Rights Reserved.
 *   Copyright (C) 2016 T-Platforms. All Rights Reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copy
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * PCIe NTB Linux driver
 *
 * Contact Information:
 * Allen Hubbe <[email protected]>
 */

#include <linux/device.h>
#include <linux/kernel.h>
#include <linux/module.h>

#include <linux/ntb.h>
#include <linux/pci.h>

#define DRIVER_NAME …
#define DRIVER_DESCRIPTION …

#define DRIVER_VERSION …
#define DRIVER_RELDATE …
#define DRIVER_AUTHOR …

MODULE_LICENSE(…) …;
MODULE_VERSION(…);
MODULE_AUTHOR(…);
MODULE_DESCRIPTION(…);

static struct bus_type ntb_bus;
static void ntb_dev_release(struct device *dev);

int __ntb_register_client(struct ntb_client *client, struct module *mod,
			  const char *mod_name)
{ … }
EXPORT_SYMBOL(…);

void ntb_unregister_client(struct ntb_client *client)
{ … }
EXPORT_SYMBOL(…);

int ntb_register_device(struct ntb_dev *ntb)
{ … }
EXPORT_SYMBOL(…);

void ntb_unregister_device(struct ntb_dev *ntb)
{ … }
EXPORT_SYMBOL(…);

int ntb_set_ctx(struct ntb_dev *ntb, void *ctx,
		const struct ntb_ctx_ops *ctx_ops)
{ … }
EXPORT_SYMBOL(…);

void ntb_clear_ctx(struct ntb_dev *ntb)
{ … }
EXPORT_SYMBOL(…);

void ntb_link_event(struct ntb_dev *ntb)
{ … }
EXPORT_SYMBOL(…);

void ntb_db_event(struct ntb_dev *ntb, int vector)
{ … }
EXPORT_SYMBOL(…);

void ntb_msg_event(struct ntb_dev *ntb)
{ … }
EXPORT_SYMBOL(…);

int ntb_default_port_number(struct ntb_dev *ntb)
{ … }
EXPORT_SYMBOL(…);

int ntb_default_peer_port_count(struct ntb_dev *ntb)
{ … }
EXPORT_SYMBOL(…);

int ntb_default_peer_port_number(struct ntb_dev *ntb, int pidx)
{ … }
EXPORT_SYMBOL(…);

int ntb_default_peer_port_idx(struct ntb_dev *ntb, int port)
{ … }
EXPORT_SYMBOL(…);

static int ntb_probe(struct device *dev)
{ … }

static void ntb_remove(struct device *dev)
{ … }

static void ntb_dev_release(struct device *dev)
{ … }

static struct bus_type ntb_bus = …;

static int __init ntb_driver_init(void)
{ … }
module_init(…) …;

static void __exit ntb_driver_exit(void)
{ … }
module_exit(ntb_driver_exit);