]>
Commit | Line | Data |
---|---|---|
11fdf7f2 TL |
1 | /*- |
2 | * BSD LICENSE | |
3 | * | |
f67539c2 TL |
4 | * Copyright (c) Intel Corporation. All rights reserved. |
5 | * Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved. | |
11fdf7f2 TL |
6 | * |
7 | * Redistribution and use in source and binary forms, with or without | |
8 | * modification, are permitted provided that the following conditions | |
9 | * are met: | |
10 | * | |
11 | * * Redistributions of source code must retain the above copyright | |
12 | * notice, this list of conditions and the following disclaimer. | |
13 | * * Redistributions in binary form must reproduce the above copyright | |
14 | * notice, this list of conditions and the following disclaimer in | |
15 | * the documentation and/or other materials provided with the | |
16 | * distribution. | |
17 | * * Neither the name of Intel Corporation nor the names of its | |
18 | * contributors may be used to endorse or promote products derived | |
19 | * from this software without specific prior written permission. | |
20 | * | |
21 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
22 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
23 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
24 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
25 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
26 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
27 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
28 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
29 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
30 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
31 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
32 | */ | |
33 | ||
34 | #ifndef SPDK_BDEV_NVME_H | |
35 | #define SPDK_BDEV_NVME_H | |
36 | ||
37 | #include "spdk/stdinc.h" | |
38 | ||
39 | #include "spdk/queue.h" | |
40 | #include "spdk/nvme.h" | |
41 | #include "spdk/bdev_module.h" | |
42 | ||
f67539c2 TL |
43 | #include "common.h" |
44 | ||
11fdf7f2 TL |
45 | enum spdk_bdev_timeout_action { |
46 | SPDK_BDEV_NVME_TIMEOUT_ACTION_NONE = 0, | |
47 | SPDK_BDEV_NVME_TIMEOUT_ACTION_RESET, | |
48 | SPDK_BDEV_NVME_TIMEOUT_ACTION_ABORT, | |
49 | }; | |
50 | ||
51 | struct spdk_bdev_nvme_opts { | |
52 | enum spdk_bdev_timeout_action action_on_timeout; | |
53 | uint64_t timeout_us; | |
54 | uint32_t retry_count; | |
f67539c2 TL |
55 | uint32_t arbitration_burst; |
56 | uint32_t low_priority_weight; | |
57 | uint32_t medium_priority_weight; | |
58 | uint32_t high_priority_weight; | |
11fdf7f2 | 59 | uint64_t nvme_adminq_poll_period_us; |
9f95a23c | 60 | uint64_t nvme_ioq_poll_period_us; |
f67539c2 TL |
61 | uint32_t io_queue_requests; |
62 | bool delay_cmd_submit; | |
11fdf7f2 TL |
63 | }; |
64 | ||
f67539c2 TL |
65 | struct spdk_nvme_qpair *bdev_nvme_get_io_qpair(struct spdk_io_channel *ctrlr_io_ch); |
66 | void bdev_nvme_get_opts(struct spdk_bdev_nvme_opts *opts); | |
67 | int bdev_nvme_set_opts(const struct spdk_bdev_nvme_opts *opts); | |
68 | int bdev_nvme_set_hotplug(bool enabled, uint64_t period_us, spdk_msg_fn cb, void *cb_ctx); | |
11fdf7f2 | 69 | |
f67539c2 TL |
70 | int bdev_nvme_create(struct spdk_nvme_transport_id *trid, |
71 | struct spdk_nvme_host_id *hostid, | |
72 | const char *base_name, | |
73 | const char **names, | |
74 | uint32_t count, | |
75 | const char *hostnqn, | |
76 | uint32_t prchk_flags, | |
77 | spdk_bdev_create_nvme_fn cb_fn, | |
78 | void *cb_ctx); | |
79 | struct spdk_nvme_ctrlr *bdev_nvme_get_ctrlr(struct spdk_bdev *bdev); | |
11fdf7f2 TL |
80 | |
81 | /** | |
82 | * Delete NVMe controller with all bdevs on top of it. | |
83 | * Requires to pass name of NVMe controller. | |
84 | * | |
85 | * \param name NVMe controller name | |
86 | * \return zero on success, -EINVAL on wrong parameters or -ENODEV if controller is not found | |
87 | */ | |
f67539c2 | 88 | int bdev_nvme_delete(const char *name); |
11fdf7f2 | 89 | |
9f95a23c | 90 | #endif /* SPDK_BDEV_NVME_H */ |