2 * Copyright (c) 2014-2018, Intel Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright notice,
10 * this list of conditions and the following disclaimer in the documentation
11 * and/or other materials provided with the distribution.
12 * * Neither the name of Intel Corporation nor the names of its contributors
13 * may be used to endorse or promote products derived from this software
14 * without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
37 /* Read an asid provided by our user.
39 * Translate a user-provided asid in @user into @asid. This uses default values
40 * for fields that are not provided by the user and for all fields, if @user is
43 * Fields set in @user that are not known (i.e. from a newer version of this
44 * library) will be ignored.
46 * Returns zero on success, a negative error code otherwise.
47 * Returns -pte_internal, if @asid is NULL.
49 extern int pt_asid_from_user(struct pt_asid *asid, const struct pt_asid *user);
51 /* Provide an asid to the user.
53 * Translate @asid into a potentially older or newer version in @user.
55 * Returns zero on success, a negative error code otherwise.
56 * Returns -pte_internal, if @user or @asid is NULL.
57 * Returns -pte_invalid, if @size is too small.
59 extern int pt_asid_to_user(struct pt_asid *user, const struct pt_asid *asid,
64 * Asids match if all fields provide either default values or are identical.
66 * Returns a positive number if @lhs matches @rhs.
67 * Returns zero if @lhs does not match @rhs.
68 * Returns a negative error code otherwise.
70 * Returns -pte_internal if @lhs or @rhs are NULL.
72 extern int pt_asid_match(const struct pt_asid *lhs, const struct pt_asid *rhs);
74 #endif /* PT_ASID_H */