xref: /freebsd/sys/dev/efidev/efidev.c (revision e4b9ff3a9e0f06ee1a859b8ca852c9f4e86a005b)
1f79d484dSWarner Losh /*-
2f79d484dSWarner Losh  * Copyright (c) 2016 Netflix, Inc.
3f79d484dSWarner Losh  * All rights reserved.
4f79d484dSWarner Losh  *
5f79d484dSWarner Losh  * Redistribution and use in source and binary forms, with or without
6f79d484dSWarner Losh  * modification, are permitted provided that the following conditions
7f79d484dSWarner Losh  * are met:
8f79d484dSWarner Losh  * 1. Redistributions of source code must retain the above copyright
9f79d484dSWarner Losh  *    notice, this list of conditions and the following disclaimer
10f79d484dSWarner Losh  *    in this position and unchanged.
11f79d484dSWarner Losh  * 2. Redistributions in binary form must reproduce the above copyright
12f79d484dSWarner Losh  *    notice, this list of conditions and the following disclaimer in the
13f79d484dSWarner Losh  *    documentation and/or other materials provided with the distribution.
14f79d484dSWarner Losh  *
15f79d484dSWarner Losh  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16f79d484dSWarner Losh  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17f79d484dSWarner Losh  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18f79d484dSWarner Losh  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19f79d484dSWarner Losh  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20f79d484dSWarner Losh  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21f79d484dSWarner Losh  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22f79d484dSWarner Losh  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23f79d484dSWarner Losh  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24f79d484dSWarner Losh  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25f79d484dSWarner Losh  */
26f79d484dSWarner Losh 
27f79d484dSWarner Losh #include <sys/cdefs.h>
28f79d484dSWarner Losh __FBSDID("$FreeBSD$");
29f79d484dSWarner Losh 
30f79d484dSWarner Losh #include <sys/param.h>
31f79d484dSWarner Losh #include <sys/systm.h>
32f79d484dSWarner Losh #include <sys/kernel.h>
33f79d484dSWarner Losh #include <sys/bus.h>
34f79d484dSWarner Losh #include <sys/conf.h>
35f79d484dSWarner Losh #include <sys/lock.h>
36f79d484dSWarner Losh #include <sys/malloc.h>
37f79d484dSWarner Losh #include <sys/module.h>
38f79d484dSWarner Losh 
39f79d484dSWarner Losh #include <machine/efi.h>
40f79d484dSWarner Losh #include <sys/efiio.h>
41f79d484dSWarner Losh 
42f79d484dSWarner Losh static d_ioctl_t efidev_ioctl;
43f79d484dSWarner Losh 
44f79d484dSWarner Losh static struct cdevsw efi_cdevsw = {
45f79d484dSWarner Losh 	.d_name = "efi",
46f79d484dSWarner Losh 	.d_version = D_VERSION,
47f79d484dSWarner Losh 	.d_ioctl = efidev_ioctl,
48f79d484dSWarner Losh };
49f79d484dSWarner Losh 
50f79d484dSWarner Losh static int
51f79d484dSWarner Losh efidev_ioctl(struct cdev *dev __unused, u_long cmd, caddr_t addr,
52f79d484dSWarner Losh     int flags __unused, struct thread *td __unused)
53f79d484dSWarner Losh {
54f79d484dSWarner Losh 	int error;
55f79d484dSWarner Losh 
56f79d484dSWarner Losh 	switch (cmd) {
57f79d484dSWarner Losh 	case EFIIOC_GET_TABLE:
58f79d484dSWarner Losh 	{
59f79d484dSWarner Losh 		struct efi_get_table_ioc *egtioc =
60f79d484dSWarner Losh 		    (struct efi_get_table_ioc *)addr;
61f79d484dSWarner Losh 
62f79d484dSWarner Losh 		error = efi_get_table(&egtioc->uuid, &egtioc->ptr);
63f79d484dSWarner Losh 		break;
64f79d484dSWarner Losh 	}
65f79d484dSWarner Losh 	case EFIIOC_GET_TIME:
66f79d484dSWarner Losh 	{
67f79d484dSWarner Losh 		struct efi_tm *tm = (struct efi_tm *)addr;
68f79d484dSWarner Losh 
69f79d484dSWarner Losh 		error = efi_get_time(tm);
70f79d484dSWarner Losh 		break;
71f79d484dSWarner Losh 	}
72f79d484dSWarner Losh 	case EFIIOC_SET_TIME:
73f79d484dSWarner Losh 	{
74f79d484dSWarner Losh 		struct efi_tm *tm = (struct efi_tm *)addr;
75f79d484dSWarner Losh 
76f79d484dSWarner Losh 		error = efi_set_time(tm);
77f79d484dSWarner Losh 		break;
78f79d484dSWarner Losh 	}
79f79d484dSWarner Losh 	case EFIIOC_VAR_GET:
80f79d484dSWarner Losh 	{
81f79d484dSWarner Losh 		struct efi_var_ioc *ev = (struct efi_var_ioc *)addr;
82f79d484dSWarner Losh 		void *data;
83f79d484dSWarner Losh 		efi_char *name;
84f79d484dSWarner Losh 
85f79d484dSWarner Losh 		data = malloc(ev->datasize, M_TEMP, M_WAITOK);
86f79d484dSWarner Losh 		name = malloc(ev->namesize, M_TEMP, M_WAITOK);
87f79d484dSWarner Losh 		error = copyin(ev->name, name, ev->namesize);
88f79d484dSWarner Losh 		if (error)
89f79d484dSWarner Losh 			goto vg_out;
90f79d484dSWarner Losh 		if (name[ev->namesize / sizeof(efi_char) - 1] != 0) {
91f79d484dSWarner Losh 			error = EINVAL;
92f79d484dSWarner Losh 			goto vg_out;
93f79d484dSWarner Losh 		}
94f79d484dSWarner Losh 
95f79d484dSWarner Losh 		error = efi_var_get(name, &ev->vendor, &ev->attrib,
96f79d484dSWarner Losh 		    &ev->datasize, data);
97f79d484dSWarner Losh 
98f79d484dSWarner Losh 		if (error == 0) {
99f79d484dSWarner Losh 			error = copyout(data, ev->data, ev->datasize);
100f79d484dSWarner Losh 		} else if (error == EOVERFLOW) {
101f79d484dSWarner Losh 			/*
102f79d484dSWarner Losh 			 * Pass back the size we really need, but
103f79d484dSWarner Losh 			 * convert the error to 0 so the copyout
104f79d484dSWarner Losh 			 * happens. datasize was updated in the
105f79d484dSWarner Losh 			 * efi_var_get call.
106f79d484dSWarner Losh 			 */
107f79d484dSWarner Losh 			ev->data = NULL;
108f79d484dSWarner Losh 			error = 0;
109f79d484dSWarner Losh 		}
110f79d484dSWarner Losh vg_out:
111f79d484dSWarner Losh 		free(data, M_TEMP);
112f79d484dSWarner Losh 		free(name, M_TEMP);
113f79d484dSWarner Losh 		break;
114f79d484dSWarner Losh 	}
115f79d484dSWarner Losh 	case EFIIOC_VAR_NEXT:
116f79d484dSWarner Losh 	{
117f79d484dSWarner Losh 		struct efi_var_ioc *ev = (struct efi_var_ioc *)addr;
118f79d484dSWarner Losh 		efi_char *name;
119f79d484dSWarner Losh 
120f79d484dSWarner Losh 		name = malloc(ev->namesize, M_TEMP, M_WAITOK);
121f79d484dSWarner Losh 		error = copyin(ev->name, name, ev->namesize);
122f79d484dSWarner Losh 		if (error)
123f79d484dSWarner Losh 			goto vn_out;
124f79d484dSWarner Losh 		/* Note: namesize is the buffer size, not the string lenght */
125f79d484dSWarner Losh 
126f79d484dSWarner Losh 		error = efi_var_nextname(&ev->namesize, name, &ev->vendor);
127f79d484dSWarner Losh 		if (error == 0) {
128f79d484dSWarner Losh 			error = copyout(name, ev->name, ev->namesize);
129f79d484dSWarner Losh 		} else if (error == EOVERFLOW) {
130f79d484dSWarner Losh 			ev->name = NULL;
131f79d484dSWarner Losh 			error = 0;
132f79d484dSWarner Losh 		}
133f79d484dSWarner Losh 	vn_out:
134f79d484dSWarner Losh 		free(name, M_TEMP);
135f79d484dSWarner Losh 		break;
136f79d484dSWarner Losh 	}
137f79d484dSWarner Losh 	case EFIIOC_VAR_SET:
138f79d484dSWarner Losh 	{
139f79d484dSWarner Losh 		struct efi_var_ioc *ev = (struct efi_var_ioc *)addr;
140f79d484dSWarner Losh 		void *data = NULL;
141f79d484dSWarner Losh 		efi_char *name;
142f79d484dSWarner Losh 
143f79d484dSWarner Losh 		/* datasize == 0 -> delete (more or less) */
144f79d484dSWarner Losh 		if (ev->datasize > 0)
145f79d484dSWarner Losh 			data = malloc(ev->datasize, M_TEMP, M_WAITOK);
146f79d484dSWarner Losh 		name = malloc(ev->namesize, M_TEMP, M_WAITOK);
147f79d484dSWarner Losh 		if (ev->datasize) {
148f79d484dSWarner Losh 			error = copyin(ev->data, data, ev->datasize);
149f79d484dSWarner Losh 			if (error)
150f79d484dSWarner Losh 				goto vs_out;
151f79d484dSWarner Losh 		}
152f79d484dSWarner Losh 		error = copyin(ev->name, name, ev->namesize);
153f79d484dSWarner Losh 		if (error)
154f79d484dSWarner Losh 			goto vs_out;
155f79d484dSWarner Losh 		if (name[ev->namesize / sizeof(efi_char) - 1] != 0) {
156f79d484dSWarner Losh 			error = EINVAL;
157f79d484dSWarner Losh 			goto vs_out;
158f79d484dSWarner Losh 		}
159f79d484dSWarner Losh 
160f79d484dSWarner Losh 		error = efi_var_set(name, &ev->vendor, ev->attrib, ev->datasize,
161f79d484dSWarner Losh 		    data);
162f79d484dSWarner Losh vs_out:
163f79d484dSWarner Losh 		free(data, M_TEMP);
164f79d484dSWarner Losh 		free(name, M_TEMP);
165f79d484dSWarner Losh 		break;
166f79d484dSWarner Losh 	}
167f79d484dSWarner Losh 	default:
168f79d484dSWarner Losh 		error = ENOTTY;
169f79d484dSWarner Losh 		break;
170f79d484dSWarner Losh 	}
171f79d484dSWarner Losh 
172f79d484dSWarner Losh 	return (error);
173f79d484dSWarner Losh }
174f79d484dSWarner Losh 
175*e4b9ff3aSKonstantin Belousov static struct cdev *efidev;
176*e4b9ff3aSKonstantin Belousov 
177*e4b9ff3aSKonstantin Belousov static int
178*e4b9ff3aSKonstantin Belousov efidev_modevents(module_t m, int event, void *arg __unused)
179f79d484dSWarner Losh {
180*e4b9ff3aSKonstantin Belousov 	struct make_dev_args mda;
181*e4b9ff3aSKonstantin Belousov 	int error;
182f79d484dSWarner Losh 
183*e4b9ff3aSKonstantin Belousov 	switch (event) {
184*e4b9ff3aSKonstantin Belousov 	case MOD_LOAD:
185*e4b9ff3aSKonstantin Belousov 		make_dev_args_init(&mda);
186*e4b9ff3aSKonstantin Belousov 		mda.mda_flags = MAKEDEV_WAITOK | MAKEDEV_CHECKNAME;
187*e4b9ff3aSKonstantin Belousov 		mda.mda_devsw = &efi_cdevsw;
188*e4b9ff3aSKonstantin Belousov 		mda.mda_uid = UID_ROOT;
189*e4b9ff3aSKonstantin Belousov 		mda.mda_gid = GID_WHEEL;
190*e4b9ff3aSKonstantin Belousov 		mda.mda_mode = 0700;
191*e4b9ff3aSKonstantin Belousov 		error = make_dev_s(&mda, &efidev, "efi");
192*e4b9ff3aSKonstantin Belousov 		return (error);
193f79d484dSWarner Losh 
194*e4b9ff3aSKonstantin Belousov 	case MOD_UNLOAD:
195*e4b9ff3aSKonstantin Belousov 		if (efidev != NULL)
196*e4b9ff3aSKonstantin Belousov 			destroy_dev(efidev);
197*e4b9ff3aSKonstantin Belousov 		efidev = NULL;
198f79d484dSWarner Losh 		return (0);
199*e4b9ff3aSKonstantin Belousov 
200*e4b9ff3aSKonstantin Belousov 	case MOD_SHUTDOWN:
201*e4b9ff3aSKonstantin Belousov 		return (0);
202*e4b9ff3aSKonstantin Belousov 
203*e4b9ff3aSKonstantin Belousov 	default:
204*e4b9ff3aSKonstantin Belousov 		return (EOPNOTSUPP);
205*e4b9ff3aSKonstantin Belousov 	}
206f79d484dSWarner Losh }
207f79d484dSWarner Losh 
208*e4b9ff3aSKonstantin Belousov static moduledata_t efidev_moddata = {
209*e4b9ff3aSKonstantin Belousov 	.name = "efidev",
210*e4b9ff3aSKonstantin Belousov 	.evhand = efidev_modevents,
211*e4b9ff3aSKonstantin Belousov 	.priv = NULL,
212*e4b9ff3aSKonstantin Belousov };
213f79d484dSWarner Losh 
214*e4b9ff3aSKonstantin Belousov DECLARE_MODULE(efidev, efidev_moddata, SI_SUB_DEVFS, SI_ORDER_ANY);
215*e4b9ff3aSKonstantin Belousov MODULE_VERSION(efidev, 1);
216*e4b9ff3aSKonstantin Belousov MODULE_DEPEND(efidev, efirt, 1, 1, 1);
217