xref: /freebsd/share/examples/kld/firmware/fwconsumer/fw_consumer.c (revision 2da066ef6d85d3f7cd8aaec14369d66254836536)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2006, Max Laier <mlaier@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice unmodified, this list of conditions, and the following
12  *    disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <sys/param.h>
30 #include <sys/kernel.h>
31 #include <sys/errno.h>
32 #include <sys/systm.h>
33 #include <sys/linker.h>
34 #include <sys/firmware.h>
35 #include <sys/proc.h>
36 #include <sys/module.h>
37 
38 static const struct firmware *fp;
39 
40 static int
41 fw_consumer_modevent(module_t mod, int type, void *unused)
42 {
43 	switch (type) {
44 	case MOD_LOAD:
45 		fp = firmware_get("beastie");
46 
47 		if (fp == NULL)
48 			return (ENOENT);
49 
50 		if (((const char *)fp->data)[fp->datasize - 1] != '\0') {
51 			firmware_put(fp, FIRMWARE_UNLOAD);
52 			return (EINVAL);
53 		}
54 		printf("%s", (const char *)fp->data);
55 
56 		return (0);
57 	case MOD_UNLOAD:
58 		printf("Bye!\n");
59 
60 		if (fp != NULL) {
61 			printf("%s", (const char *)fp->data);
62 			firmware_put(fp, FIRMWARE_UNLOAD);
63 		}
64 
65 		return (0);
66 	}
67 	return (EINVAL);
68 }
69 
70 static moduledata_t fw_consumer_mod = {
71 	"fw_consumer",
72 	fw_consumer_modevent,
73 	0
74 };
75 DECLARE_MODULE(fw_consumer, fw_consumer_mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
76 MODULE_VERSION(fw_consumer, 1);
77 MODULE_DEPEND(fw_consumer, firmware, 1, 1, 1);
78