]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/nvme/host/fabrics.h
2 * NVMe over Fabrics common host code.
3 * Copyright (c) 2015-2016 HGST, a Western Digital Company.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 #ifndef _NVME_FABRICS_H
15 #define _NVME_FABRICS_H 1
18 #include <linux/inet.h>
20 #define NVMF_MIN_QUEUE_SIZE 16
21 #define NVMF_MAX_QUEUE_SIZE 1024
22 #define NVMF_DEF_QUEUE_SIZE 128
23 #define NVMF_DEF_RECONNECT_DELAY 10
24 /* default to 600 seconds of reconnect attempts before giving up */
25 #define NVMF_DEF_CTRL_LOSS_TMO 600
28 * Define a host as seen by the target. We allocate one at boot, but also
29 * allow the override it when creating controllers. This is both to provide
30 * persistence of the Host NQN over multiple boots, and to allow using
31 * multiple ones, for example in a container scenario. Because we must not
32 * use different Host NQNs with the same Host ID we generate a Host ID and
33 * use this structure to keep track of the relation between the two.
37 struct list_head list
;
38 char nqn
[NVMF_NQN_SIZE
];
43 * enum nvmf_parsing_opts - used to define the sysfs parsing options used.
47 NVMF_OPT_TRANSPORT
= 1 << 0,
48 NVMF_OPT_NQN
= 1 << 1,
49 NVMF_OPT_TRADDR
= 1 << 2,
50 NVMF_OPT_TRSVCID
= 1 << 3,
51 NVMF_OPT_QUEUE_SIZE
= 1 << 4,
52 NVMF_OPT_NR_IO_QUEUES
= 1 << 5,
53 NVMF_OPT_TL_RETRY_COUNT
= 1 << 6,
54 NVMF_OPT_KATO
= 1 << 7,
55 NVMF_OPT_HOSTNQN
= 1 << 8,
56 NVMF_OPT_RECONNECT_DELAY
= 1 << 9,
57 NVMF_OPT_HOST_TRADDR
= 1 << 10,
58 NVMF_OPT_CTRL_LOSS_TMO
= 1 << 11,
59 NVMF_OPT_HOST_ID
= 1 << 12,
63 * struct nvmf_ctrl_options - Used to hold the options specified
64 * with the parsing opts enum.
65 * @mask: Used by the fabrics library to parse through sysfs options
66 * on adding a NVMe controller.
67 * @transport: Holds the fabric transport "technology name" (for a lack of
68 * better description) that will be used by an NVMe controller
70 * @subsysnqn: Hold the fully qualified NQN subystem name (format defined
71 * in the NVMe specification, "NVMe Qualified Names").
72 * @traddr: The transport-specific TRADDR field for a port on the
73 * subsystem which is adding a controller.
74 * @trsvcid: The transport-specific TRSVCID field for a port on the
75 * subsystem which is adding a controller.
76 * @host_traddr: A transport-specific field identifying the NVME host port
77 * to use for the connection to the controller.
78 * @queue_size: Number of IO queue elements.
79 * @nr_io_queues: Number of controller IO queues that will be established.
80 * @reconnect_delay: Time between two consecutive reconnect attempts.
81 * @discovery_nqn: indicates if the subsysnqn is the well-known discovery NQN.
82 * @kato: Keep-alive timeout.
83 * @host: Virtual NVMe host, contains the NQN and Host ID.
84 * @max_reconnects: maximum number of allowed reconnect attempts before removing
85 * the controller, (-1) means reconnect forever, zero means remove
88 struct nvmf_ctrl_options
{
96 unsigned int nr_io_queues
;
97 unsigned int reconnect_delay
;
100 struct nvmf_host
*host
;
105 * struct nvmf_transport_ops - used to register a specific
106 * fabric implementation of NVMe fabrics.
107 * @entry: Used by the fabrics library to add the new
108 * registration entry to its linked-list internal tree.
109 * @name: Name of the NVMe fabric driver implementation.
110 * @required_opts: sysfs command-line options that must be specified
111 * when adding a new NVMe controller.
112 * @allowed_opts: sysfs command-line options that can be specified
113 * when adding a new NVMe controller.
114 * @create_ctrl(): function pointer that points to a non-NVMe
115 * implementation-specific fabric technology
116 * that would go into starting up that fabric
117 * for the purpose of conneciton to an NVMe controller
118 * using that fabric technology.
121 * 1. At minimum, 'required_opts' and 'allowed_opts' should
122 * be set to the same enum parsing options defined earlier.
123 * 2. create_ctrl() must be defined (even if it does nothing)
125 struct nvmf_transport_ops
{
126 struct list_head entry
;
130 struct nvme_ctrl
*(*create_ctrl
)(struct device
*dev
,
131 struct nvmf_ctrl_options
*opts
);
134 int nvmf_reg_read32(struct nvme_ctrl
*ctrl
, u32 off
, u32
*val
);
135 int nvmf_reg_read64(struct nvme_ctrl
*ctrl
, u32 off
, u64
*val
);
136 int nvmf_reg_write32(struct nvme_ctrl
*ctrl
, u32 off
, u32 val
);
137 int nvmf_connect_admin_queue(struct nvme_ctrl
*ctrl
);
138 int nvmf_connect_io_queue(struct nvme_ctrl
*ctrl
, u16 qid
);
139 int nvmf_register_transport(struct nvmf_transport_ops
*ops
);
140 void nvmf_unregister_transport(struct nvmf_transport_ops
*ops
);
141 void nvmf_free_options(struct nvmf_ctrl_options
*opts
);
142 int nvmf_get_address(struct nvme_ctrl
*ctrl
, char *buf
, int size
);
143 bool nvmf_should_reconnect(struct nvme_ctrl
*ctrl
);
145 #endif /* _NVME_FABRICS_H */