xref: /freebsd/sys/xen/xenmem/xenmem_if.m (revision d6b92ffa) 
1#-
2# Copyright (c) 2015 Roger Pau Monné <royger@FreeBSD.org>
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9#    notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26# $FreeBSD$
27#
28
29#include <sys/bus.h>
30
31INTERFACE xenmem;
32
33#
34# Default implementations of some methods.
35#
36CODE {
37        static struct resource *
38        xenmem_generic_alloc(device_t dev, device_t child, int *res_id,
39            size_t size)
40        {
41                device_t parent;
42
43                parent = device_get_parent(dev);
44                if (parent == NULL)
45                        return (NULL);
46                return (XENMEM_ALLOC(parent, child, res_id, size));
47        }
48
49        static int
50        xenmem_generic_free(device_t dev, device_t child, int res_id,
51            struct resource *res)
52        {
53                device_t parent;
54
55                parent = device_get_parent(dev);
56                if (parent == NULL)
57                        return (ENXIO);
58                return (XENMEM_FREE(parent, child, res_id, res));
59        }
60};
61
62/**
63 * @brief Request for unused physical memory regions.
64 *
65 * @param _dev          the device whose child was being probed.
66 * @param _child        the child device which failed to probe.
67 * @param _res_id       a pointer to the resource identifier.
68 * @param _size         size of the required memory region.
69 *
70 * @returns             the resource which was allocated or @c NULL if no
71 *                      resource could be allocated.
72 */
73METHOD struct resource * alloc {
74	device_t                _dev;
75	device_t                _child;
76	int                    *_res_id;
77	size_t                  _size;
78} DEFAULT xenmem_generic_alloc;
79
80/**
81 * @brief Free physical memory regions.
82 *
83 * @param _dev          the device whose child was being probed.
84 * @param _child        the child device which failed to probe.
85 * @param _res_id       the resource identifier.
86 * @param _res          the resource.
87 *
88 * @returns             0 on success, otherwise an error code.
89 */
90METHOD int free {
91	device_t                _dev;
92	device_t                _child;
93	int                     _res_id;
94	struct resource        *_res;
95} DEFAULT xenmem_generic_free;
96