aboutsummaryrefslogtreecommitdiff
path: root/src/core/acpimac.c
blob: 1cc8220b170995b91f757658489c9db7264dbd6f (plain)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
 * Copyright (C) 2021 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., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 *
 * You can also choose to distribute this program under the terms of
 * the Unmodified Binary Distribution Licence (as given in the file
 * COPYING.UBDL), provided that you have satisfied its requirements.
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

#include <string.h>
#include <errno.h>
#include <ipxe/acpi.h>
#include <ipxe/base16.h>
#include <ipxe/ethernet.h>
#include <ipxe/if_ether.h>
#include <ipxe/acpimac.h>

/** @file
 *
 * ACPI MAC address
 *
 */

/** Colour for debug messages */
#define colour FADT_SIGNATURE

/** AMAC signature */
#define AMAC_SIGNATURE ACPI_SIGNATURE ( 'A', 'M', 'A', 'C' )

/** MACA signature */
#define MACA_SIGNATURE ACPI_SIGNATURE ( 'M', 'A', 'C', 'A' )

/** Maximum number of bytes to skip after AMAC/MACA signature
 *
 * This is entirely empirical.
 */
#define AUXMAC_MAX_SKIP 8

/**
 * Extract MAC address from DSDT/SSDT
 *
 * @v zsdt		DSDT or SSDT
 * @v len		Length of DSDT/SSDT
 * @v offset		Offset of signature within DSDT/SSDT
 * @v data		Data buffer
 * @ret rc		Return status code
 *
 * Some vendors provide a "system MAC address" within the DSDT/SSDT,
 * to be used to override the MAC address for a USB docking station.
 *
 * A full implementation would require an ACPI bytecode interpreter,
 * since at least one OEM allows the MAC address to be constructed by
 * executable ACPI bytecode (rather than a fixed data structure).
 *
 * We instead attempt to extract a plausible-looking "_AUXMAC_#.....#"
 * string that appears shortly after an "AMAC" or "MACA" signature.
 * This should work for most implementations encountered in practice.
 */
static int acpi_extract_mac ( userptr_t zsdt, size_t len, size_t offset,
			      void *data ) {
	static const char prefix[9] = "_AUXMAC_#";
	uint8_t *hw_addr = data;
	size_t skip = 0;
	char auxmac[ sizeof ( prefix ) /* "_AUXMAC_#" */ +
		     ( ETH_ALEN * 2 ) /* MAC */ + 1 /* "#" */ + 1 /* NUL */ ];
	char *mac = &auxmac[ sizeof ( prefix ) ];
	int decoded_len;
	int rc;

	/* Skip signature and at least one tag byte */
	offset += ( 4 /* signature */ + 1 /* tag byte */ );

	/* Scan for "_AUXMAC_#.....#" close to signature */
	for ( skip = 0 ;
	      ( ( skip < AUXMAC_MAX_SKIP ) &&
		( offset + skip + sizeof ( auxmac ) ) < len ) ;
	      skip++ ) {

		/* Read value */
		copy_from_user ( auxmac, zsdt, ( offset + skip ),
				 sizeof ( auxmac ) );

		/* Check for expected format */
		if ( memcmp ( auxmac, prefix, sizeof ( prefix ) ) != 0 )
			continue;
		if ( auxmac[ sizeof ( auxmac ) - 2 ] != '#' )
			continue;
		if ( auxmac[ sizeof ( auxmac ) - 1 ] != '\0' )
			continue;
		DBGC ( colour, "ACPI found MAC string \"%s\"\n", auxmac );

		/* Terminate MAC address string */
		mac = &auxmac[ sizeof ( prefix ) ];
		mac[ ETH_ALEN * 2 ] = '\0';

		/* Decode MAC address */
		decoded_len = base16_decode ( mac, hw_addr, ETH_ALEN );
		if ( decoded_len < 0 ) {
			rc = decoded_len;
			DBGC ( colour, "ACPI could not decode MAC \"%s\": %s\n",
			       mac, strerror ( rc ) );
			return rc;
		}

		/* Check MAC address validity */
		if ( ! is_valid_ether_addr ( hw_addr ) ) {
			DBGC ( colour, "ACPI has invalid MAC %s\n",
			       eth_ntoa ( hw_addr ) );
			return -EINVAL;
		}

		return 0;
	}

	return -ENOENT;
}

/**
 * Extract MAC address from DSDT/SSDT
 *
 * @v hw_addr		MAC address to fill in
 * @ret rc		Return status code
 */
int acpi_mac ( uint8_t *hw_addr ) {
	int rc;

	/* Look for an "AMAC" address */
	if ( ( rc = acpi_extract ( AMAC_SIGNATURE, hw_addr,
				   acpi_extract_mac ) ) == 0 )
		return 0;

	/* Look for a "MACA" address */
	if ( ( rc = acpi_extract ( MACA_SIGNATURE, hw_addr,
				   acpi_extract_mac ) ) == 0 )
		return 0;

	return -ENOENT;
}