summaryrefslogtreecommitdiffstats
path: root/src/core/interface.c
blob: 15df49d3cbca509312ac7701ec81b25f27c628b3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/*
 * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or any later version.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <assert.h>
#include <gpxe/interface.h>

/** @file
 *
 * Object communication interfaces
 *
 */

/**
 * Obtain reference to interface
 *
 * @v intf		Interface
 * @ret intf		Interface
 *
 * Increases the reference count on the interface.
 */
static struct interface * intf_get ( struct interface *intf ) {
	intf->refcnt ( intf, +1 );
	return intf;
}

/**
 * Drop reference to interface
 *
 * @v intf		Interface
 *
 * Decreases the reference count on the interface.
 */
static void intf_put ( struct interface *intf ) {
	intf->refcnt ( intf, -1 );
}

/**
 * Plug an interface into a new destination interface
 *
 * @v intf		Interface
 * @v dest		New destination interface
 *
 * The reference to the existing destination interface is dropped, a
 * reference to the new destination interface is obtained, and the
 * interface is updated to point to the new destination interface.
 *
 * Note that there is no "unplug" call; instead you must plug the
 * interface into a null interface.
 */
void plug ( struct interface *intf, struct interface *dest ) {
	intf_put ( intf->dest );
	intf->dest = intf_get ( dest );
}

/**
 * Null update reference count
 *
 * @v intf		Interface
 * @v delta		Change to apply to reference count
 *
 * Use this as the refcnt() method for an interface that does not need
 * to support reference counting.
 */
void null_refcnt ( struct interface *intf __unused, int delta __unused ) {
	/* Do nothing */
}