GNU Linux-libre 4.4.289-gnu1
[releases.git] / drivers / dma / acpi-dma.c
1 /*
2  * ACPI helpers for DMA request / controller
3  *
4  * Based on of-dma.c
5  *
6  * Copyright (C) 2013, Intel Corporation
7  * Authors: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
8  *          Mika Westerberg <mika.westerberg@linux.intel.com>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  */
14
15 #include <linux/device.h>
16 #include <linux/err.h>
17 #include <linux/module.h>
18 #include <linux/kernel.h>
19 #include <linux/list.h>
20 #include <linux/mutex.h>
21 #include <linux/slab.h>
22 #include <linux/ioport.h>
23 #include <linux/acpi.h>
24 #include <linux/acpi_dma.h>
25 #include <linux/property.h>
26
27 static LIST_HEAD(acpi_dma_list);
28 static DEFINE_MUTEX(acpi_dma_lock);
29
30 /**
31  * acpi_dma_parse_resource_group - match device and parse resource group
32  * @grp:        CSRT resource group
33  * @adev:       ACPI device to match with
34  * @adma:       struct acpi_dma of the given DMA controller
35  *
36  * In order to match a device from DSDT table to the corresponding CSRT device
37  * we use MMIO address and IRQ.
38  *
39  * Return:
40  * 1 on success, 0 when no information is available, or appropriate errno value
41  * on error.
42  */
43 static int acpi_dma_parse_resource_group(const struct acpi_csrt_group *grp,
44                 struct acpi_device *adev, struct acpi_dma *adma)
45 {
46         const struct acpi_csrt_shared_info *si;
47         struct list_head resource_list;
48         struct resource_entry *rentry;
49         resource_size_t mem = 0, irq = 0;
50         int ret;
51
52         if (grp->shared_info_length != sizeof(struct acpi_csrt_shared_info))
53                 return -ENODEV;
54
55         INIT_LIST_HEAD(&resource_list);
56         ret = acpi_dev_get_resources(adev, &resource_list, NULL, NULL);
57         if (ret <= 0)
58                 return 0;
59
60         list_for_each_entry(rentry, &resource_list, node) {
61                 if (resource_type(rentry->res) == IORESOURCE_MEM)
62                         mem = rentry->res->start;
63                 else if (resource_type(rentry->res) == IORESOURCE_IRQ)
64                         irq = rentry->res->start;
65         }
66
67         acpi_dev_free_resource_list(&resource_list);
68
69         /* Consider initial zero values as resource not found */
70         if (mem == 0 && irq == 0)
71                 return 0;
72
73         si = (const struct acpi_csrt_shared_info *)&grp[1];
74
75         /* Match device by MMIO */
76         if (si->mmio_base_low != lower_32_bits(mem) ||
77             si->mmio_base_high != upper_32_bits(mem))
78                 return 0;
79
80         /* Match device by Linux vIRQ */
81         ret = acpi_register_gsi(NULL, si->gsi_interrupt, si->interrupt_mode, si->interrupt_polarity);
82         if (ret != irq)
83                 return 0;
84
85         dev_dbg(&adev->dev, "matches with %.4s%04X (rev %u)\n",
86                 (char *)&grp->vendor_id, grp->device_id, grp->revision);
87
88         /* Check if the request line range is available */
89         if (si->base_request_line == 0 && si->num_handshake_signals == 0)
90                 return 0;
91
92         adma->base_request_line = si->base_request_line;
93         adma->end_request_line = si->base_request_line +
94                                  si->num_handshake_signals - 1;
95
96         dev_dbg(&adev->dev, "request line base: 0x%04x end: 0x%04x\n",
97                 adma->base_request_line, adma->end_request_line);
98
99         return 1;
100 }
101
102 /**
103  * acpi_dma_parse_csrt - parse CSRT to exctract additional DMA resources
104  * @adev:       ACPI device to match with
105  * @adma:       struct acpi_dma of the given DMA controller
106  *
107  * CSRT or Core System Resources Table is a proprietary ACPI table
108  * introduced by Microsoft. This table can contain devices that are not in
109  * the system DSDT table. In particular DMA controllers might be described
110  * here.
111  *
112  * We are using this table to get the request line range of the specific DMA
113  * controller to be used later.
114  */
115 static void acpi_dma_parse_csrt(struct acpi_device *adev, struct acpi_dma *adma)
116 {
117         struct acpi_csrt_group *grp, *end;
118         struct acpi_table_csrt *csrt;
119         acpi_status status;
120         int ret;
121
122         status = acpi_get_table(ACPI_SIG_CSRT, 0,
123                                 (struct acpi_table_header **)&csrt);
124         if (ACPI_FAILURE(status)) {
125                 if (status != AE_NOT_FOUND)
126                         dev_warn(&adev->dev, "failed to get the CSRT table\n");
127                 return;
128         }
129
130         grp = (struct acpi_csrt_group *)(csrt + 1);
131         end = (struct acpi_csrt_group *)((void *)csrt + csrt->header.length);
132
133         while (grp < end) {
134                 ret = acpi_dma_parse_resource_group(grp, adev, adma);
135                 if (ret < 0) {
136                         dev_warn(&adev->dev,
137                                  "error in parsing resource group\n");
138                         return;
139                 }
140
141                 grp = (struct acpi_csrt_group *)((void *)grp + grp->length);
142         }
143 }
144
145 /**
146  * acpi_dma_controller_register - Register a DMA controller to ACPI DMA helpers
147  * @dev:                struct device of DMA controller
148  * @acpi_dma_xlate:     translation function which converts a dma specifier
149  *                      into a dma_chan structure
150  * @data                pointer to controller specific data to be used by
151  *                      translation function
152  *
153  * Allocated memory should be freed with appropriate acpi_dma_controller_free()
154  * call.
155  *
156  * Return:
157  * 0 on success or appropriate errno value on error.
158  */
159 int acpi_dma_controller_register(struct device *dev,
160                 struct dma_chan *(*acpi_dma_xlate)
161                 (struct acpi_dma_spec *, struct acpi_dma *),
162                 void *data)
163 {
164         struct acpi_device *adev;
165         struct acpi_dma *adma;
166
167         if (!dev || !acpi_dma_xlate)
168                 return -EINVAL;
169
170         /* Check if the device was enumerated by ACPI */
171         adev = ACPI_COMPANION(dev);
172         if (!adev)
173                 return -EINVAL;
174
175         adma = kzalloc(sizeof(*adma), GFP_KERNEL);
176         if (!adma)
177                 return -ENOMEM;
178
179         adma->dev = dev;
180         adma->acpi_dma_xlate = acpi_dma_xlate;
181         adma->data = data;
182
183         acpi_dma_parse_csrt(adev, adma);
184
185         /* Now queue acpi_dma controller structure in list */
186         mutex_lock(&acpi_dma_lock);
187         list_add_tail(&adma->dma_controllers, &acpi_dma_list);
188         mutex_unlock(&acpi_dma_lock);
189
190         return 0;
191 }
192 EXPORT_SYMBOL_GPL(acpi_dma_controller_register);
193
194 /**
195  * acpi_dma_controller_free - Remove a DMA controller from ACPI DMA helpers list
196  * @dev:        struct device of DMA controller
197  *
198  * Memory allocated by acpi_dma_controller_register() is freed here.
199  *
200  * Return:
201  * 0 on success or appropriate errno value on error.
202  */
203 int acpi_dma_controller_free(struct device *dev)
204 {
205         struct acpi_dma *adma;
206
207         if (!dev)
208                 return -EINVAL;
209
210         mutex_lock(&acpi_dma_lock);
211
212         list_for_each_entry(adma, &acpi_dma_list, dma_controllers)
213                 if (adma->dev == dev) {
214                         list_del(&adma->dma_controllers);
215                         mutex_unlock(&acpi_dma_lock);
216                         kfree(adma);
217                         return 0;
218                 }
219
220         mutex_unlock(&acpi_dma_lock);
221         return -ENODEV;
222 }
223 EXPORT_SYMBOL_GPL(acpi_dma_controller_free);
224
225 static void devm_acpi_dma_release(struct device *dev, void *res)
226 {
227         acpi_dma_controller_free(dev);
228 }
229
230 /**
231  * devm_acpi_dma_controller_register - resource managed acpi_dma_controller_register()
232  * @dev:                device that is registering this DMA controller
233  * @acpi_dma_xlate:     translation function
234  * @data                pointer to controller specific data
235  *
236  * Managed acpi_dma_controller_register(). DMA controller registered by this
237  * function are automatically freed on driver detach. See
238  * acpi_dma_controller_register() for more information.
239  *
240  * Return:
241  * 0 on success or appropriate errno value on error.
242  */
243 int devm_acpi_dma_controller_register(struct device *dev,
244                 struct dma_chan *(*acpi_dma_xlate)
245                 (struct acpi_dma_spec *, struct acpi_dma *),
246                 void *data)
247 {
248         void *res;
249         int ret;
250
251         res = devres_alloc(devm_acpi_dma_release, 0, GFP_KERNEL);
252         if (!res)
253                 return -ENOMEM;
254
255         ret = acpi_dma_controller_register(dev, acpi_dma_xlate, data);
256         if (ret) {
257                 devres_free(res);
258                 return ret;
259         }
260         devres_add(dev, res);
261         return 0;
262 }
263 EXPORT_SYMBOL_GPL(devm_acpi_dma_controller_register);
264
265 /**
266  * devm_acpi_dma_controller_free - resource managed acpi_dma_controller_free()
267  *
268  * Unregister a DMA controller registered with
269  * devm_acpi_dma_controller_register(). Normally this function will not need to
270  * be called and the resource management code will ensure that the resource is
271  * freed.
272  */
273 void devm_acpi_dma_controller_free(struct device *dev)
274 {
275         WARN_ON(devres_release(dev, devm_acpi_dma_release, NULL, NULL));
276 }
277 EXPORT_SYMBOL_GPL(devm_acpi_dma_controller_free);
278
279 /**
280  * acpi_dma_update_dma_spec - prepare dma specifier to pass to translation function
281  * @adma:       struct acpi_dma of DMA controller
282  * @dma_spec:   dma specifier to update
283  *
284  * Accordingly to ACPI 5.0 Specification Table 6-170 "Fixed DMA Resource
285  * Descriptor":
286  *      DMA Request Line bits is a platform-relative number uniquely
287  *      identifying the request line assigned. Request line-to-Controller
288  *      mapping is done in a controller-specific OS driver.
289  * That's why we can safely adjust slave_id when the appropriate controller is
290  * found.
291  *
292  * Return:
293  * 0, if no information is avaiable, -1 on mismatch, and 1 otherwise.
294  */
295 static int acpi_dma_update_dma_spec(struct acpi_dma *adma,
296                 struct acpi_dma_spec *dma_spec)
297 {
298         /* Set link to the DMA controller device */
299         dma_spec->dev = adma->dev;
300
301         /* Check if the request line range is available */
302         if (adma->base_request_line == 0 && adma->end_request_line == 0)
303                 return 0;
304
305         /* Check if slave_id falls to the range */
306         if (dma_spec->slave_id < adma->base_request_line ||
307             dma_spec->slave_id > adma->end_request_line)
308                 return -1;
309
310         /*
311          * Here we adjust slave_id. It should be a relative number to the base
312          * request line.
313          */
314         dma_spec->slave_id -= adma->base_request_line;
315
316         return 1;
317 }
318
319 struct acpi_dma_parser_data {
320         struct acpi_dma_spec dma_spec;
321         size_t index;
322         size_t n;
323 };
324
325 /**
326  * acpi_dma_parse_fixed_dma - Parse FixedDMA ACPI resources to a DMA specifier
327  * @res:        struct acpi_resource to get FixedDMA resources from
328  * @data:       pointer to a helper struct acpi_dma_parser_data
329  */
330 static int acpi_dma_parse_fixed_dma(struct acpi_resource *res, void *data)
331 {
332         struct acpi_dma_parser_data *pdata = data;
333
334         if (res->type == ACPI_RESOURCE_TYPE_FIXED_DMA) {
335                 struct acpi_resource_fixed_dma *dma = &res->data.fixed_dma;
336
337                 if (pdata->n++ == pdata->index) {
338                         pdata->dma_spec.chan_id = dma->channels;
339                         pdata->dma_spec.slave_id = dma->request_lines;
340                 }
341         }
342
343         /* Tell the ACPI core to skip this resource */
344         return 1;
345 }
346
347 /**
348  * acpi_dma_request_slave_chan_by_index - Get the DMA slave channel
349  * @dev:        struct device to get DMA request from
350  * @index:      index of FixedDMA descriptor for @dev
351  *
352  * Return:
353  * Pointer to appropriate dma channel on success or an error pointer.
354  */
355 struct dma_chan *acpi_dma_request_slave_chan_by_index(struct device *dev,
356                 size_t index)
357 {
358         struct acpi_dma_parser_data pdata;
359         struct acpi_dma_spec *dma_spec = &pdata.dma_spec;
360         struct list_head resource_list;
361         struct acpi_device *adev;
362         struct acpi_dma *adma;
363         struct dma_chan *chan = NULL;
364         int found;
365
366         /* Check if the device was enumerated by ACPI */
367         if (!dev)
368                 return ERR_PTR(-ENODEV);
369
370         adev = ACPI_COMPANION(dev);
371         if (!adev)
372                 return ERR_PTR(-ENODEV);
373
374         memset(&pdata, 0, sizeof(pdata));
375         pdata.index = index;
376
377         /* Initial values for the request line and channel */
378         dma_spec->chan_id = -1;
379         dma_spec->slave_id = -1;
380
381         INIT_LIST_HEAD(&resource_list);
382         acpi_dev_get_resources(adev, &resource_list,
383                         acpi_dma_parse_fixed_dma, &pdata);
384         acpi_dev_free_resource_list(&resource_list);
385
386         if (dma_spec->slave_id < 0 || dma_spec->chan_id < 0)
387                 return ERR_PTR(-ENODEV);
388
389         mutex_lock(&acpi_dma_lock);
390
391         list_for_each_entry(adma, &acpi_dma_list, dma_controllers) {
392                 /*
393                  * We are not going to call translation function if slave_id
394                  * doesn't fall to the request range.
395                  */
396                 found = acpi_dma_update_dma_spec(adma, dma_spec);
397                 if (found < 0)
398                         continue;
399                 chan = adma->acpi_dma_xlate(dma_spec, adma);
400                 /*
401                  * Try to get a channel only from the DMA controller that
402                  * matches the slave_id. See acpi_dma_update_dma_spec()
403                  * description for the details.
404                  */
405                 if (found > 0 || chan)
406                         break;
407         }
408
409         mutex_unlock(&acpi_dma_lock);
410         return chan ? chan : ERR_PTR(-EPROBE_DEFER);
411 }
412 EXPORT_SYMBOL_GPL(acpi_dma_request_slave_chan_by_index);
413
414 /**
415  * acpi_dma_request_slave_chan_by_name - Get the DMA slave channel
416  * @dev:        struct device to get DMA request from
417  * @name:       represents corresponding FixedDMA descriptor for @dev
418  *
419  * In order to support both Device Tree and ACPI in a single driver we
420  * translate the names "tx" and "rx" here based on the most common case where
421  * the first FixedDMA descriptor is TX and second is RX.
422  *
423  * If the device has "dma-names" property the FixedDMA descriptor indices
424  * are retrieved based on those. Otherwise the function falls back using
425  * hardcoded indices.
426  *
427  * Return:
428  * Pointer to appropriate dma channel on success or an error pointer.
429  */
430 struct dma_chan *acpi_dma_request_slave_chan_by_name(struct device *dev,
431                 const char *name)
432 {
433         int index;
434
435         index = device_property_match_string(dev, "dma-names", name);
436         if (index < 0) {
437                 if (!strcmp(name, "tx"))
438                         index = 0;
439                 else if (!strcmp(name, "rx"))
440                         index = 1;
441                 else
442                         return ERR_PTR(-ENODEV);
443         }
444
445         dev_dbg(dev, "found DMA channel \"%s\" at index %d\n", name, index);
446         return acpi_dma_request_slave_chan_by_index(dev, index);
447 }
448 EXPORT_SYMBOL_GPL(acpi_dma_request_slave_chan_by_name);
449
450 /**
451  * acpi_dma_simple_xlate - Simple ACPI DMA engine translation helper
452  * @dma_spec: pointer to ACPI DMA specifier
453  * @adma: pointer to ACPI DMA controller data
454  *
455  * A simple translation function for ACPI based devices. Passes &struct
456  * dma_spec to the DMA controller driver provided filter function.
457  *
458  * Return:
459  * Pointer to the channel if found or %NULL otherwise.
460  */
461 struct dma_chan *acpi_dma_simple_xlate(struct acpi_dma_spec *dma_spec,
462                 struct acpi_dma *adma)
463 {
464         struct acpi_dma_filter_info *info = adma->data;
465
466         if (!info || !info->filter_fn)
467                 return NULL;
468
469         return dma_request_channel(info->dma_cap, info->filter_fn, dma_spec);
470 }
471 EXPORT_SYMBOL_GPL(acpi_dma_simple_xlate);