drivers/dma/of-dma.c

   1 /*
   2  * Device tree helpers for DMA request / controller
   3  *
   4  * Based on of_gpio.c
   5  *
   6  * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #include <linux/device.h>
  14 #include <linux/err.h>
  15 #include <linux/module.h>
  16 #include <linux/mutex.h>
  17 #include <linux/slab.h>
  18 #include <linux/of.h>
  19 #include <linux/of_dma.h>
  20
  21 static LIST_HEAD(of_dma_list);
  22 static DEFINE_MUTEX(of_dma_lock);
  23
  24 /**
  25  * of_dma_find_controller - Get a DMA controller in DT DMA helpers list
  26  * @dma_spec:   pointer to DMA specifier as found in the device tree
  27  *
  28  * Finds a DMA controller with matching device node and number for dma cells
  29  * in a list of registered DMA controllers. If a match is found a valid pointer
  30  * to the DMA data stored is retuned. A NULL pointer is returned if no match is
  31  * found.
  32  */
  33 static struct of_dma *of_dma_find_controller(struct of_phandle_args *dma_spec)
  34 {
  35         struct of_dma *ofdma;
  36
  37         list_for_each_entry(ofdma, &of_dma_list, of_dma_controllers)
  38                 if (ofdma->of_node == dma_spec->np)
  39                         return ofdma;
  40
  41         pr_debug("%s: can't find DMA controller %pOF\n", __func__,
  42                  dma_spec->np);
  43
  44         return NULL;
  45 }
  46
  47 /**
  48  * of_dma_router_xlate - translation function for router devices
  49  * @dma_spec:   pointer to DMA specifier as found in the device tree
  50  * @of_dma:     pointer to DMA controller data (router information)
  51  *
  52  * The function creates new dma_spec to be passed to the router driver's
  53  * of_dma_route_allocate() function to prepare a dma_spec which will be used
  54  * to request channel from the real DMA controller.
  55  */
  56 static struct dma_chan *of_dma_router_xlate(struct of_phandle_args *dma_spec,
  57                                             struct of_dma *ofdma)
  58 {
  59         struct dma_chan         *chan;
  60         struct of_dma           *ofdma_target;
  61         struct of_phandle_args  dma_spec_target;
  62         void                    *route_data;
  63
  64         /* translate the request for the real DMA controller */
  65         memcpy(&dma_spec_target, dma_spec, sizeof(dma_spec_target));
  66         route_data = ofdma->of_dma_route_allocate(&dma_spec_target, ofdma);
  67         if (IS_ERR(route_data))
  68                 return NULL;
  69
  70         ofdma_target = of_dma_find_controller(&dma_spec_target);
  71         if (!ofdma_target) {
  72                 ofdma->dma_router->route_free(ofdma->dma_router->dev,
  73                                               route_data);
  74                 chan = ERR_PTR(-EPROBE_DEFER);
  75                 goto err;
  76         }
  77
  78         chan = ofdma_target->of_dma_xlate(&dma_spec_target, ofdma_target);
  79         if (IS_ERR_OR_NULL(chan)) {
  80                 ofdma->dma_router->route_free(ofdma->dma_router->dev,
  81                                               route_data);
  82         } else {
  83                 chan->router = ofdma->dma_router;
  84                 chan->route_data = route_data;
  85         }
  86
  87 err:
  88         /*
  89          * Need to put the node back since the ofdma->of_dma_route_allocate
  90          * has taken it for generating the new, translated dma_spec
  91          */
  92         of_node_put(dma_spec_target.np);
  93         return chan;
  94 }
  95
  96 /**
  97  * of_dma_controller_register - Register a DMA controller to DT DMA helpers
  98  * @np:                 device node of DMA controller
  99  * @of_dma_xlate:       translation function which converts a phandle
 100  *                      arguments list into a dma_chan structure
 101  * @data                pointer to controller specific data to be used by
 102  *                      translation function
 103  *
 104  * Returns 0 on success or appropriate errno value on error.
 105  *
 106  * Allocated memory should be freed with appropriate of_dma_controller_free()
 107  * call.
 108  */
 109 int of_dma_controller_register(struct device_node *np,
 110                                 struct dma_chan *(*of_dma_xlate)
 111                                 (struct of_phandle_args *, struct of_dma *),
 112                                 void *data)
 113 {
 114         struct of_dma   *ofdma;
 115
 116         if (!np || !of_dma_xlate) {
 117                 pr_err("%s: not enough information provided\n", __func__);
 118                 return -EINVAL;
 119         }
 120
 121         ofdma = kzalloc(sizeof(*ofdma), GFP_KERNEL);
 122         if (!ofdma)
 123                 return -ENOMEM;
 124
 125         ofdma->of_node = np;
 126         ofdma->of_dma_xlate = of_dma_xlate;
 127         ofdma->of_dma_data = data;
 128
 129         /* Now queue of_dma controller structure in list */
 130         mutex_lock(&of_dma_lock);
 131         list_add_tail(&ofdma->of_dma_controllers, &of_dma_list);
 132         mutex_unlock(&of_dma_lock);
 133
 134         return 0;
 135 }
 136 EXPORT_SYMBOL_GPL(of_dma_controller_register);
 137
 138 /**
 139  * of_dma_controller_free - Remove a DMA controller from DT DMA helpers list
 140  * @np:         device node of DMA controller
 141  *
 142  * Memory allocated by of_dma_controller_register() is freed here.
 143  */
 144 void of_dma_controller_free(struct device_node *np)
 145 {
 146         struct of_dma *ofdma;
 147
 148         mutex_lock(&of_dma_lock);
 149
 150         list_for_each_entry(ofdma, &of_dma_list, of_dma_controllers)
 151                 if (ofdma->of_node == np) {
 152                         list_del(&ofdma->of_dma_controllers);
 153                         kfree(ofdma);
 154                         break;
 155                 }
 156
 157         mutex_unlock(&of_dma_lock);
 158 }
 159 EXPORT_SYMBOL_GPL(of_dma_controller_free);
 160
 161 /**
 162  * of_dma_router_register - Register a DMA router to DT DMA helpers as a
 163  *                          controller
 164  * @np:                         device node of DMA router
 165  * @of_dma_route_allocate:      setup function for the router which need to
 166  *                              modify the dma_spec for the DMA controller to
 167  *                              use and to set up the requested route.
 168  * @dma_router:                 pointer to dma_router structure to be used when
 169  *                              the route need to be free up.
 170  *
 171  * Returns 0 on success or appropriate errno value on error.
 172  *
 173  * Allocated memory should be freed with appropriate of_dma_controller_free()
 174  * call.
 175  */
 176 int of_dma_router_register(struct device_node *np,
 177                            void *(*of_dma_route_allocate)
 178                            (struct of_phandle_args *, struct of_dma *),
 179                            struct dma_router *dma_router)
 180 {
 181         struct of_dma   *ofdma;
 182
 183         if (!np || !of_dma_route_allocate || !dma_router) {
 184                 pr_err("%s: not enough information provided\n", __func__);
 185                 return -EINVAL;
 186         }
 187
 188         ofdma = kzalloc(sizeof(*ofdma), GFP_KERNEL);
 189         if (!ofdma)
 190                 return -ENOMEM;
 191
 192         ofdma->of_node = np;
 193         ofdma->of_dma_xlate = of_dma_router_xlate;
 194         ofdma->of_dma_route_allocate = of_dma_route_allocate;
 195         ofdma->dma_router = dma_router;
 196
 197         /* Now queue of_dma controller structure in list */
 198         mutex_lock(&of_dma_lock);
 199         list_add_tail(&ofdma->of_dma_controllers, &of_dma_list);
 200         mutex_unlock(&of_dma_lock);
 201
 202         return 0;
 203 }
 204 EXPORT_SYMBOL_GPL(of_dma_router_register);
 205
 206 /**
 207  * of_dma_match_channel - Check if a DMA specifier matches name
 208  * @np:         device node to look for DMA channels
 209  * @name:       channel name to be matched
 210  * @index:      index of DMA specifier in list of DMA specifiers
 211  * @dma_spec:   pointer to DMA specifier as found in the device tree
 212  *
 213  * Check if the DMA specifier pointed to by the index in a list of DMA
 214  * specifiers, matches the name provided. Returns 0 if the name matches and
 215  * a valid pointer to the DMA specifier is found. Otherwise returns -ENODEV.
 216  */
 217 static int of_dma_match_channel(struct device_node *np, const char *name,
 218                                 int index, struct of_phandle_args *dma_spec)
 219 {
 220         const char *s;
 221
 222         if (of_property_read_string_index(np, "dma-names", index, &s))
 223                 return -ENODEV;
 224
 225         if (strcmp(name, s))
 226                 return -ENODEV;
 227
 228         if (of_parse_phandle_with_args(np, "dmas", "#dma-cells", index,
 229                                        dma_spec))
 230                 return -ENODEV;
 231
 232         return 0;
 233 }
 234
 235 /**
 236  * of_dma_request_slave_channel - Get the DMA slave channel
 237  * @np:         device node to get DMA request from
 238  * @name:       name of desired channel
 239  *
 240  * Returns pointer to appropriate DMA channel on success or an error pointer.
 241  */
 242 struct dma_chan *of_dma_request_slave_channel(struct device_node *np,
 243                                               const char *name)
 244 {
 245         struct of_phandle_args  dma_spec;
 246         struct of_dma           *ofdma;
 247         struct dma_chan         *chan;
 248         int                     count, i, start;
 249         int                     ret_no_channel = -ENODEV;
 250         static atomic_t         last_index;
 251
 252         if (!np || !name) {
 253                 pr_err("%s: not enough information provided\n", __func__);
 254                 return ERR_PTR(-ENODEV);
 255         }
 256
 257         /* Silently fail if there is not even the "dmas" property */
 258         if (!of_find_property(np, "dmas", NULL))
 259                 return ERR_PTR(-ENODEV);
 260
 261         count = of_property_count_strings(np, "dma-names");
 262         if (count < 0) {
 263                 pr_err("%s: dma-names property of node '%pOF' missing or empty\n",
 264                         __func__, np);
 265                 return ERR_PTR(-ENODEV);
 266         }
 267
 268         /*
 269          * approximate an average distribution across multiple
 270          * entries with the same name
 271          */
 272         start = atomic_inc_return(&last_index);
 273         for (i = 0; i < count; i++) {
 274                 if (of_dma_match_channel(np, name,
 275                                          (i + start) % count,
 276                                          &dma_spec))
 277                         continue;
 278
 279                 mutex_lock(&of_dma_lock);
 280                 ofdma = of_dma_find_controller(&dma_spec);
 281
 282                 if (ofdma) {
 283                         chan = ofdma->of_dma_xlate(&dma_spec, ofdma);
 284                 } else {
 285                         ret_no_channel = -EPROBE_DEFER;
 286                         chan = NULL;
 287                 }
 288
 289                 mutex_unlock(&of_dma_lock);
 290
 291                 of_node_put(dma_spec.np);
 292
 293                 if (chan)
 294                         return chan;
 295         }
 296
 297         return ERR_PTR(ret_no_channel);
 298 }
 299 EXPORT_SYMBOL_GPL(of_dma_request_slave_channel);
 300
 301 /**
 302  * of_dma_simple_xlate - Simple DMA engine translation function
 303  * @dma_spec:   pointer to DMA specifier as found in the device tree
 304  * @of_dma:     pointer to DMA controller data
 305  *
 306  * A simple translation function for devices that use a 32-bit value for the
 307  * filter_param when calling the DMA engine dma_request_channel() function.
 308  * Note that this translation function requires that #dma-cells is equal to 1
 309  * and the argument of the dma specifier is the 32-bit filter_param. Returns
 310  * pointer to appropriate dma channel on success or NULL on error.
 311  */
 312 struct dma_chan *of_dma_simple_xlate(struct of_phandle_args *dma_spec,
 313                                                 struct of_dma *ofdma)
 314 {
 315         int count = dma_spec->args_count;
 316         struct of_dma_filter_info *info = ofdma->of_dma_data;
 317
 318         if (!info || !info->filter_fn)
 319                 return NULL;
 320
 321         if (count != 1)
 322                 return NULL;
 323
 324         return dma_request_channel(info->dma_cap, info->filter_fn,
 325                         &dma_spec->args[0]);
 326 }
 327 EXPORT_SYMBOL_GPL(of_dma_simple_xlate);
 328
 329 /**
 330  * of_dma_xlate_by_chan_id - Translate dt property to DMA channel by channel id
 331  * @dma_spec:   pointer to DMA specifier as found in the device tree
 332  * @of_dma:     pointer to DMA controller data
 333  *
 334  * This function can be used as the of xlate callback for DMA driver which wants
 335  * to match the channel based on the channel id. When using this xlate function
 336  * the #dma-cells propety of the DMA controller dt node needs to be set to 1.
 337  * The data parameter of of_dma_controller_register must be a pointer to the
 338  * dma_device struct the function should match upon.
 339  *
 340  * Returns pointer to appropriate dma channel on success or NULL on error.
 341  */
 342 struct dma_chan *of_dma_xlate_by_chan_id(struct of_phandle_args *dma_spec,
 343                                          struct of_dma *ofdma)
 344 {
 345         struct dma_device *dev = ofdma->of_dma_data;
 346         struct dma_chan *chan, *candidate = NULL;
 347
 348         if (!dev || dma_spec->args_count != 1)
 349                 return NULL;
 350
 351         list_for_each_entry(chan, &dev->channels, device_node)
 352                 if (chan->chan_id == dma_spec->args[0]) {
 353                         candidate = chan;
 354                         break;
 355                 }
 356
 357         if (!candidate)
 358                 return NULL;
 359
 360         return dma_get_slave_channel(candidate);
 361 }
 362 EXPORT_SYMBOL_GPL(of_dma_xlate_by_chan_id);