xref: /spdk/lib/scsi/port.c (revision eb8b1e20a9c8a6bc79f32fde8693d2791a74c34d)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
5  *   Copyright (c) Intel Corporation.
6  *   All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include "scsi_internal.h"
36 
37 struct spdk_scsi_port *
38 spdk_scsi_port_create(uint64_t id, uint16_t index, const char *name)
39 {
40 	struct spdk_scsi_port *port;
41 
42 	port = calloc(1, sizeof(struct spdk_scsi_port));
43 
44 	if (!port) {
45 		return NULL;
46 	}
47 
48 	if (spdk_scsi_port_construct(port, id, index, name) != 0) {
49 		spdk_scsi_port_free(&port);
50 		return NULL;
51 	}
52 
53 	return port;
54 }
55 
56 void
57 spdk_scsi_port_free(struct spdk_scsi_port **pport)
58 {
59 	struct spdk_scsi_port *port;
60 
61 	if (!pport) {
62 		return;
63 	}
64 
65 	port = *pport;
66 	*pport = NULL;
67 	free(port);
68 }
69 
70 int
71 spdk_scsi_port_construct(struct spdk_scsi_port *port, uint64_t id, uint16_t index,
72 			 const char *name)
73 {
74 	if (strlen(name) >= sizeof(port->name)) {
75 		SPDK_ERRLOG("port name too long\n");
76 		return -1;
77 	}
78 
79 	port->is_used = 1;
80 	port->id = id;
81 	port->index = index;
82 	snprintf(port->name, sizeof(port->name), "%s", name);
83 	return 0;
84 }
85 
86 void
87 spdk_scsi_port_destruct(struct spdk_scsi_port *port)
88 {
89 	memset(port, 0, sizeof(struct spdk_scsi_port));
90 }
91 
92 const char *
93 spdk_scsi_port_get_name(const struct spdk_scsi_port *port)
94 {
95 	return port->name;
96 }
97