1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * AMD ACPI support for ACPI2platform device.
4 *
5 * Copyright (c) 2014,2015 AMD Corporation.
6 * Authors: Ken Xue <Ken.Xue@amd.com>
7 * Wu, Jeff <Jeff.Wu@amd.com>
8 */
9
10#include <linux/acpi.h>
11#include <linux/clkdev.h>
12#include <linux/clk-provider.h>
13#include <linux/err.h>
14#include <linux/io.h>
15#include <linux/platform_data/clk-fch.h>
16#include <linux/platform_device.h>
17
18#include "internal.h"
19
20struct apd_private_data;
21
22/**
23 * struct apd_device_desc - a descriptor for apd device
24 * @fixed_clk_rate: fixed rate input clock source for acpi device;
25 * 0 means no fixed rate input clock source
26 * @properties: build-in properties of the device such as UART
27 * @setup: a hook routine to set device resource during create platform device
28 *
29 * Device description defined as acpi_device_id.driver_data
30 */
31struct apd_device_desc {
32 unsigned int fixed_clk_rate;
33 struct property_entry *properties;
34 int (*setup)(struct apd_private_data *pdata);
35};
36
37struct apd_private_data {
38 struct clk *clk;
39 struct acpi_device *adev;
40 const struct apd_device_desc *dev_desc;
41};
42
43#if defined(CONFIG_X86_AMD_PLATFORM_DEVICE) || defined(CONFIG_ARM64)
44#define APD_ADDR(desc) ((unsigned long)&desc)
45
46static int acpi_apd_setup(struct apd_private_data *pdata)
47{
48 const struct apd_device_desc *dev_desc = pdata->dev_desc;
49 struct clk *clk;
50
51 if (dev_desc->fixed_clk_rate) {
52 clk = clk_register_fixed_rate(dev: &pdata->adev->dev,
53 name: dev_name(dev: &pdata->adev->dev),
54 NULL, flags: 0, fixed_rate: dev_desc->fixed_clk_rate);
55 clk_register_clkdev(clk, NULL, dev_name(dev: &pdata->adev->dev));
56 pdata->clk = clk;
57 }
58
59 return 0;
60}
61
62#ifdef CONFIG_X86_AMD_PLATFORM_DEVICE
63
64static int fch_misc_setup(struct apd_private_data *pdata)
65{
66 struct acpi_device *adev = pdata->adev;
67 const union acpi_object *obj;
68 struct platform_device *clkdev;
69 struct fch_clk_data *clk_data;
70 struct resource_entry *rentry;
71 struct list_head resource_list;
72 int ret;
73
74 clk_data = devm_kzalloc(dev: &adev->dev, size: sizeof(*clk_data), GFP_KERNEL);
75 if (!clk_data)
76 return -ENOMEM;
77
78 INIT_LIST_HEAD(list: &resource_list);
79 ret = acpi_dev_get_memory_resources(adev, list: &resource_list);
80 if (ret < 0)
81 return -ENOENT;
82
83 if (!acpi_dev_get_property(adev, name: "clk-name", ACPI_TYPE_STRING, obj: &obj)) {
84 clk_data->name = devm_kzalloc(dev: &adev->dev, size: obj->string.length,
85 GFP_KERNEL);
86 if (!clk_data->name)
87 return -ENOMEM;
88
89 strcpy(p: clk_data->name, q: obj->string.pointer);
90 } else {
91 /* Set default name to mclk if entry missing in firmware */
92 clk_data->name = "mclk";
93 }
94
95 list_for_each_entry(rentry, &resource_list, node) {
96 clk_data->base = devm_ioremap(dev: &adev->dev, offset: rentry->res->start,
97 size: resource_size(res: rentry->res));
98 break;
99 }
100 if (!clk_data->base)
101 return -ENOMEM;
102
103 acpi_dev_free_resource_list(list: &resource_list);
104
105 clkdev = platform_device_register_data(parent: &adev->dev, name: "clk-fch",
106 PLATFORM_DEVID_NONE, data: clk_data,
107 size: sizeof(*clk_data));
108 return PTR_ERR_OR_ZERO(ptr: clkdev);
109}
110
111static const struct apd_device_desc cz_i2c_desc = {
112 .setup = acpi_apd_setup,
113 .fixed_clk_rate = 133000000,
114};
115
116static const struct apd_device_desc wt_i2c_desc = {
117 .setup = acpi_apd_setup,
118 .fixed_clk_rate = 150000000,
119};
120
121static struct property_entry uart_properties[] = {
122 PROPERTY_ENTRY_U32("reg-io-width", 4),
123 PROPERTY_ENTRY_U32("reg-shift", 2),
124 PROPERTY_ENTRY_BOOL("snps,uart-16550-compatible"),
125 { },
126};
127
128static const struct apd_device_desc cz_uart_desc = {
129 .setup = acpi_apd_setup,
130 .fixed_clk_rate = 48000000,
131 .properties = uart_properties,
132};
133
134static const struct apd_device_desc fch_misc_desc = {
135 .setup = fch_misc_setup,
136};
137#endif /* CONFIG_X86_AMD_PLATFORM_DEVICE */
138
139#ifdef CONFIG_ARM64
140static const struct apd_device_desc xgene_i2c_desc = {
141 .setup = acpi_apd_setup,
142 .fixed_clk_rate = 100000000,
143};
144
145static const struct apd_device_desc vulcan_spi_desc = {
146 .setup = acpi_apd_setup,
147 .fixed_clk_rate = 133000000,
148};
149
150static const struct apd_device_desc hip07_i2c_desc = {
151 .setup = acpi_apd_setup,
152 .fixed_clk_rate = 200000000,
153};
154
155static const struct apd_device_desc hip08_i2c_desc = {
156 .setup = acpi_apd_setup,
157 .fixed_clk_rate = 250000000,
158};
159
160static const struct apd_device_desc hip08_lite_i2c_desc = {
161 .setup = acpi_apd_setup,
162 .fixed_clk_rate = 125000000,
163};
164
165static const struct apd_device_desc thunderx2_i2c_desc = {
166 .setup = acpi_apd_setup,
167 .fixed_clk_rate = 125000000,
168};
169
170static const struct apd_device_desc nxp_i2c_desc = {
171 .setup = acpi_apd_setup,
172 .fixed_clk_rate = 350000000,
173};
174
175static const struct apd_device_desc hip08_spi_desc = {
176 .setup = acpi_apd_setup,
177 .fixed_clk_rate = 250000000,
178};
179#endif /* CONFIG_ARM64 */
180
181#endif
182
183/*
184 * Create platform device during acpi scan attach handle.
185 * Return value > 0 on success of creating device.
186 */
187static int acpi_apd_create_device(struct acpi_device *adev,
188 const struct acpi_device_id *id)
189{
190 const struct apd_device_desc *dev_desc = (void *)id->driver_data;
191 struct apd_private_data *pdata;
192 struct platform_device *pdev;
193 int ret;
194
195 if (!dev_desc) {
196 pdev = acpi_create_platform_device(adev, NULL);
197 return IS_ERR_OR_NULL(ptr: pdev) ? PTR_ERR(ptr: pdev) : 1;
198 }
199
200 pdata = kzalloc(size: sizeof(*pdata), GFP_KERNEL);
201 if (!pdata)
202 return -ENOMEM;
203
204 pdata->adev = adev;
205 pdata->dev_desc = dev_desc;
206
207 if (dev_desc->setup) {
208 ret = dev_desc->setup(pdata);
209 if (ret)
210 goto err_out;
211 }
212
213 adev->driver_data = pdata;
214 pdev = acpi_create_platform_device(adev, dev_desc->properties);
215 if (!IS_ERR_OR_NULL(ptr: pdev))
216 return 1;
217
218 ret = PTR_ERR(ptr: pdev);
219 adev->driver_data = NULL;
220
221 err_out:
222 kfree(objp: pdata);
223 return ret;
224}
225
226static const struct acpi_device_id acpi_apd_device_ids[] = {
227 /* Generic apd devices */
228#ifdef CONFIG_X86_AMD_PLATFORM_DEVICE
229 { "AMD0010", APD_ADDR(cz_i2c_desc) },
230 { "AMD0020", APD_ADDR(cz_uart_desc) },
231 { "AMD0030", },
232 { "AMD0040", APD_ADDR(fch_misc_desc)},
233 { "AMDI0010", APD_ADDR(wt_i2c_desc) },
234 { "AMDI0019", APD_ADDR(wt_i2c_desc) },
235 { "AMDI0020", APD_ADDR(cz_uart_desc) },
236 { "AMDI0022", APD_ADDR(cz_uart_desc) },
237 { "HYGO0010", APD_ADDR(wt_i2c_desc) },
238#endif
239#ifdef CONFIG_ARM64
240 { "APMC0D0F", APD_ADDR(xgene_i2c_desc) },
241 { "BRCM900D", APD_ADDR(vulcan_spi_desc) },
242 { "CAV900D", APD_ADDR(vulcan_spi_desc) },
243 { "CAV9007", APD_ADDR(thunderx2_i2c_desc) },
244 { "HISI02A1", APD_ADDR(hip07_i2c_desc) },
245 { "HISI02A2", APD_ADDR(hip08_i2c_desc) },
246 { "HISI02A3", APD_ADDR(hip08_lite_i2c_desc) },
247 { "HISI0173", APD_ADDR(hip08_spi_desc) },
248 { "NXP0001", APD_ADDR(nxp_i2c_desc) },
249#endif
250 { }
251};
252
253static struct acpi_scan_handler apd_handler = {
254 .ids = acpi_apd_device_ids,
255 .attach = acpi_apd_create_device,
256};
257
258void __init acpi_apd_init(void)
259{
260 acpi_scan_add_handler(handler: &apd_handler);
261}
262

source code of linux/drivers/acpi/acpi_apd.c