kernel/drivers/staging/fsl-mc/include/mc-private.h

   1 /*
   2  * Freescale Management Complex (MC) bus private declarations
   3  *
   4  * Copyright (C) 2014 Freescale Semiconductor, Inc.
   5  * Author: German Rivera <German.Rivera@freescale.com>
   6  *
   7  * This file is licensed under the terms of the GNU General Public
   8  * License version 2. This program is licensed "as is" without any
   9  * warranty of any kind, whether express or implied.
  10  */
  11 #ifndef _FSL_MC_PRIVATE_H_
  12 #define _FSL_MC_PRIVATE_H_
  13
  14 #include "../include/mc.h"
  15 #include <linux/mutex.h>
  16 #include <linux/stringify.h>
  17
  18 #define FSL_MC_DPRC_DRIVER_NAME    "fsl_mc_dprc"
  19
  20 #define FSL_MC_DEVICE_MATCH(_mc_dev, _obj_desc) \
  21         (strcmp((_mc_dev)->obj_desc.type, (_obj_desc)->type) == 0 && \
  22          (_mc_dev)->obj_desc.id == (_obj_desc)->id)
  23
  24 #define FSL_MC_IS_ALLOCATABLE(_obj_type) \
  25         (strcmp(_obj_type, "dpbp") == 0 || \
  26          strcmp(_obj_type, "dpmcp") == 0 || \
  27          strcmp(_obj_type, "dpcon") == 0)
  28
  29 /**
  30  * struct fsl_mc - Private data of a "fsl,qoriq-mc" platform device
  31  * @root_mc_bus_dev: MC object device representing the root DPRC
  32  * @num_translation_ranges: number of entries in addr_translation_ranges
  33  * @translation_ranges: array of bus to system address translation ranges
  34  */
  35 struct fsl_mc {
  36         struct fsl_mc_device *root_mc_bus_dev;
  37         u8 num_translation_ranges;
  38         struct fsl_mc_addr_translation_range *translation_ranges;
  39 };
  40
  41 /**
  42  * struct fsl_mc_addr_translation_range - bus to system address translation
  43  * range
  44  * @mc_region_type: Type of MC region for the range being translated
  45  * @start_mc_offset: Start MC offset of the range being translated
  46  * @end_mc_offset: MC offset of the first byte after the range (last MC
  47  * offset of the range is end_mc_offset - 1)
  48  * @start_phys_addr: system physical address corresponding to start_mc_addr
  49  */
  50 struct fsl_mc_addr_translation_range {
  51         enum dprc_region_type mc_region_type;
  52         u64 start_mc_offset;
  53         u64 end_mc_offset;
  54         phys_addr_t start_phys_addr;
  55 };
  56
  57 /**
  58  * struct fsl_mc_resource_pool - Pool of MC resources of a given
  59  * type
  60  * @type: type of resources in the pool
  61  * @max_count: maximum number of resources in the pool
  62  * @free_count: number of free resources in the pool
  63  * @mutex: mutex to serialize access to the pool's free list
  64  * @free_list: anchor node of list of free resources in the pool
  65  * @mc_bus: pointer to the MC bus that owns this resource pool
  66  */
  67 struct fsl_mc_resource_pool {
  68         enum fsl_mc_pool_type type;
  69         int16_t max_count;
  70         int16_t free_count;
  71         struct mutex mutex;     /* serializes access to free_list */
  72         struct list_head free_list;
  73         struct fsl_mc_bus *mc_bus;
  74 };
  75
  76 /**
  77  * struct fsl_mc_bus - logical bus that corresponds to a physical DPRC
  78  * @mc_dev: fsl-mc device for the bus device itself.
  79  * @resource_pools: array of resource pools (one pool per resource type)
  80  * for this MC bus. These resources represent allocatable entities
  81  * from the physical DPRC.
  82  * @scan_mutex: Serializes bus scanning
  83  */
  84 struct fsl_mc_bus {
  85         struct fsl_mc_device mc_dev;
  86         struct fsl_mc_resource_pool resource_pools[FSL_MC_NUM_POOL_TYPES];
  87         struct mutex scan_mutex;    /* serializes bus scanning */
  88 };
  89
  90 #define to_fsl_mc_bus(_mc_dev) \
  91         container_of(_mc_dev, struct fsl_mc_bus, mc_dev)
  92
  93 int __must_check fsl_mc_device_add(struct dprc_obj_desc *obj_desc,
  94                                    struct fsl_mc_io *mc_io,
  95                                    struct device *parent_dev,
  96                                    struct fsl_mc_device **new_mc_dev);
  97
  98 void fsl_mc_device_remove(struct fsl_mc_device *mc_dev);
  99
 100 int dprc_scan_container(struct fsl_mc_device *mc_bus_dev);
 101
 102 int dprc_scan_objects(struct fsl_mc_device *mc_bus_dev);
 103
 104 int __init dprc_driver_init(void);
 105
 106 void dprc_driver_exit(void);
 107
 108 int __init fsl_mc_allocator_driver_init(void);
 109
 110 void __exit fsl_mc_allocator_driver_exit(void);
 111
 112 int __must_check fsl_mc_resource_allocate(struct fsl_mc_bus *mc_bus,
 113                                           enum fsl_mc_pool_type pool_type,
 114                                           struct fsl_mc_resource
 115                                                           **new_resource);
 116
 117 void fsl_mc_resource_free(struct fsl_mc_resource *resource);
 118
 119 #endif /* _FSL_MC_PRIVATE_H_ */