1 | /* $NetBSD: firmware.h,v 1.6 2014/08/06 13:51:12 riastradh Exp $ */ |
2 | |
3 | /*- |
4 | * Copyright (c) 2013 The NetBSD Foundation, Inc. |
5 | * All rights reserved. |
6 | * |
7 | * This code is derived from software contributed to The NetBSD Foundation |
8 | * by Taylor R. Campbell. |
9 | * |
10 | * Redistribution and use in source and binary forms, with or without |
11 | * modification, are permitted provided that the following conditions |
12 | * are met: |
13 | * 1. Redistributions of source code must retain the above copyright |
14 | * notice, this list of conditions and the following disclaimer. |
15 | * 2. Redistributions in binary form must reproduce the above copyright |
16 | * notice, this list of conditions and the following disclaimer in the |
17 | * documentation and/or other materials provided with the distribution. |
18 | * |
19 | * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS |
20 | * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED |
21 | * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
22 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS |
23 | * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
24 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
25 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
26 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
27 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
28 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
29 | * POSSIBILITY OF SUCH DAMAGE. |
30 | */ |
31 | |
32 | #ifndef _LINUX_FIRMWARE_H_ |
33 | #define _LINUX_FIRMWARE_H_ |
34 | |
35 | #include <sys/types.h> |
36 | #include <sys/device.h> |
37 | #include <sys/kmem.h> |
38 | #include <sys/systm.h> |
39 | |
40 | #include <dev/firmload.h> |
41 | |
42 | struct device; |
43 | |
44 | struct firmware { |
45 | void *data; |
46 | size_t size; |
47 | }; |
48 | |
49 | static inline int |
50 | request_firmware(const struct firmware **fwp, const char *image_name, |
51 | struct device *dev) |
52 | { |
53 | const char *drvname; |
54 | struct firmware *fw; |
55 | firmware_handle_t handle; |
56 | int ret; |
57 | |
58 | fw = kmem_alloc(sizeof(*fw), KM_SLEEP); |
59 | |
60 | /* |
61 | * If driver xyz(4) asks for xyz/foo/bar.bin, turn that into |
62 | * just foo/bar.bin. This leaves open the possibility of name |
63 | * collisions. Let's hope upstream is sensible about this. |
64 | */ |
65 | drvname = device_cfdriver(dev)->cd_name; |
66 | if ((strncmp(drvname, image_name, strlen(drvname)) == 0) && |
67 | (image_name[strlen(drvname)] == '/')) |
68 | image_name += (strlen(drvname) + 1); |
69 | |
70 | /* XXX errno NetBSD->Linux */ |
71 | ret = -firmware_open(drvname, image_name, &handle); |
72 | if (ret) |
73 | goto fail0; |
74 | fw->size = firmware_get_size(handle); |
75 | fw->data = firmware_malloc(fw->size); |
76 | |
77 | /* XXX errno NetBSD->Linux */ |
78 | ret = -firmware_read(handle, 0, fw->data, fw->size); |
79 | (void)firmware_close(handle); |
80 | if (ret) |
81 | goto fail1; |
82 | |
83 | /* Success! */ |
84 | *fwp = fw; |
85 | return 0; |
86 | |
87 | fail1: firmware_free(fw->data, fw->size); |
88 | fail0: KASSERT(ret); |
89 | kmem_free(fw, sizeof(*fw)); |
90 | *fwp = NULL; |
91 | return ret; |
92 | } |
93 | |
94 | static inline void |
95 | release_firmware(const struct firmware *fw) |
96 | { |
97 | |
98 | if (fw != NULL) { |
99 | firmware_free(fw->data, fw->size); |
100 | kmem_free(__UNCONST(fw), sizeof(*fw)); |
101 | } |
102 | } |
103 | |
104 | #endif /* _LINUX_FIRMWARE_H_ */ |
105 | |