1 /* 2 * Copyright (c) 2009-2013, NVIDIA Corporation. All rights reserved. 3 * 4 * This program is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License as published by 6 * the Free Software Foundation; either version 2 of the License, or 7 * (at your option) any later version. 8 * 9 * This program is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 12 * more details. 13 * 14 * You should have received a copy of the GNU General Public License along 15 * with this program; if not, write to the Free Software Foundation, Inc., 16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 17 */ 18 19 #ifndef __LINUX_HOST1X_H 20 #define __LINUX_HOST1X_H 21 22 #include <linux/device.h> 23 #include <linux/types.h> 24 25 enum host1x_class { 26 HOST1X_CLASS_HOST1X = 0x1, 27 HOST1X_CLASS_GR2D = 0x51, 28 HOST1X_CLASS_GR2D_SB = 0x52, 29 HOST1X_CLASS_VIC = 0x5D, 30 HOST1X_CLASS_GR3D = 0x60, 31 }; 32 33 struct host1x_client; 34 35 /** 36 * struct host1x_client_ops - host1x client operations 37 * @init: host1x client initialization code 38 * @exit: host1x client tear down code 39 */ 40 struct host1x_client_ops { 41 int (*init)(struct host1x_client *client); 42 int (*exit)(struct host1x_client *client); 43 }; 44 45 /** 46 * struct host1x_client - host1x client structure 47 * @list: list node for the host1x client 48 * @parent: pointer to struct device representing the host1x controller 49 * @dev: pointer to struct device backing this host1x client 50 * @ops: host1x client operations 51 * @class: host1x class represented by this client 52 * @channel: host1x channel associated with this client 53 * @syncpts: array of syncpoints requested for this client 54 * @num_syncpts: number of syncpoints requested for this client 55 */ 56 struct host1x_client { 57 struct list_head list; 58 struct device *parent; 59 struct device *dev; 60 61 const struct host1x_client_ops *ops; 62 63 enum host1x_class class; 64 struct host1x_channel *channel; 65 66 struct host1x_syncpt **syncpts; 67 unsigned int num_syncpts; 68 }; 69 70 /* 71 * host1x buffer objects 72 */ 73 74 struct host1x_bo; 75 struct sg_table; 76 77 struct host1x_bo_ops { 78 struct host1x_bo *(*get)(struct host1x_bo *bo); 79 void (*put)(struct host1x_bo *bo); 80 dma_addr_t (*pin)(struct host1x_bo *bo, struct sg_table **sgt); 81 void (*unpin)(struct host1x_bo *bo, struct sg_table *sgt); 82 void *(*mmap)(struct host1x_bo *bo); 83 void (*munmap)(struct host1x_bo *bo, void *addr); 84 void *(*kmap)(struct host1x_bo *bo, unsigned int pagenum); 85 void (*kunmap)(struct host1x_bo *bo, unsigned int pagenum, void *addr); 86 }; 87 88 struct host1x_bo { 89 const struct host1x_bo_ops *ops; 90 }; 91 92 static inline void host1x_bo_init(struct host1x_bo *bo, 93 const struct host1x_bo_ops *ops) 94 { 95 bo->ops = ops; 96 } 97 98 static inline struct host1x_bo *host1x_bo_get(struct host1x_bo *bo) 99 { 100 return bo->ops->get(bo); 101 } 102 103 static inline void host1x_bo_put(struct host1x_bo *bo) 104 { 105 bo->ops->put(bo); 106 } 107 108 static inline dma_addr_t host1x_bo_pin(struct host1x_bo *bo, 109 struct sg_table **sgt) 110 { 111 return bo->ops->pin(bo, sgt); 112 } 113 114 static inline void host1x_bo_unpin(struct host1x_bo *bo, struct sg_table *sgt) 115 { 116 bo->ops->unpin(bo, sgt); 117 } 118 119 static inline void *host1x_bo_mmap(struct host1x_bo *bo) 120 { 121 return bo->ops->mmap(bo); 122 } 123 124 static inline void host1x_bo_munmap(struct host1x_bo *bo, void *addr) 125 { 126 bo->ops->munmap(bo, addr); 127 } 128 129 static inline void *host1x_bo_kmap(struct host1x_bo *bo, unsigned int pagenum) 130 { 131 return bo->ops->kmap(bo, pagenum); 132 } 133 134 static inline void host1x_bo_kunmap(struct host1x_bo *bo, 135 unsigned int pagenum, void *addr) 136 { 137 bo->ops->kunmap(bo, pagenum, addr); 138 } 139 140 /* 141 * host1x syncpoints 142 */ 143 144 #define HOST1X_SYNCPT_CLIENT_MANAGED (1 << 0) 145 #define HOST1X_SYNCPT_HAS_BASE (1 << 1) 146 147 struct host1x_syncpt_base; 148 struct host1x_syncpt; 149 struct host1x; 150 151 struct host1x_syncpt *host1x_syncpt_get(struct host1x *host, u32 id); 152 u32 host1x_syncpt_id(struct host1x_syncpt *sp); 153 u32 host1x_syncpt_read_min(struct host1x_syncpt *sp); 154 u32 host1x_syncpt_read_max(struct host1x_syncpt *sp); 155 u32 host1x_syncpt_read(struct host1x_syncpt *sp); 156 int host1x_syncpt_incr(struct host1x_syncpt *sp); 157 u32 host1x_syncpt_incr_max(struct host1x_syncpt *sp, u32 incrs); 158 int host1x_syncpt_wait(struct host1x_syncpt *sp, u32 thresh, long timeout, 159 u32 *value); 160 struct host1x_syncpt *host1x_syncpt_request(struct host1x_client *client, 161 unsigned long flags); 162 void host1x_syncpt_free(struct host1x_syncpt *sp); 163 164 struct host1x_syncpt_base *host1x_syncpt_get_base(struct host1x_syncpt *sp); 165 u32 host1x_syncpt_base_id(struct host1x_syncpt_base *base); 166 167 /* 168 * host1x channel 169 */ 170 171 struct host1x_channel; 172 struct host1x_job; 173 174 struct host1x_channel *host1x_channel_request(struct device *dev); 175 struct host1x_channel *host1x_channel_get(struct host1x_channel *channel); 176 void host1x_channel_put(struct host1x_channel *channel); 177 int host1x_job_submit(struct host1x_job *job); 178 179 /* 180 * host1x job 181 */ 182 183 struct host1x_reloc { 184 struct { 185 struct host1x_bo *bo; 186 unsigned long offset; 187 } cmdbuf; 188 struct { 189 struct host1x_bo *bo; 190 unsigned long offset; 191 } target; 192 unsigned long shift; 193 }; 194 195 struct host1x_waitchk { 196 struct host1x_bo *bo; 197 u32 offset; 198 u32 syncpt_id; 199 u32 thresh; 200 }; 201 202 struct host1x_job { 203 /* When refcount goes to zero, job can be freed */ 204 struct kref ref; 205 206 /* List entry */ 207 struct list_head list; 208 209 /* Channel where job is submitted to */ 210 struct host1x_channel *channel; 211 212 u32 client; 213 214 /* Gathers and their memory */ 215 struct host1x_job_gather *gathers; 216 unsigned int num_gathers; 217 218 /* Wait checks to be processed at submit time */ 219 struct host1x_waitchk *waitchk; 220 unsigned int num_waitchk; 221 u32 waitchk_mask; 222 223 /* Array of handles to be pinned & unpinned */ 224 struct host1x_reloc *relocarray; 225 unsigned int num_relocs; 226 struct host1x_job_unpin_data *unpins; 227 unsigned int num_unpins; 228 229 dma_addr_t *addr_phys; 230 dma_addr_t *gather_addr_phys; 231 dma_addr_t *reloc_addr_phys; 232 233 /* Sync point id, number of increments and end related to the submit */ 234 u32 syncpt_id; 235 u32 syncpt_incrs; 236 u32 syncpt_end; 237 238 /* Maximum time to wait for this job */ 239 unsigned int timeout; 240 241 /* Index and number of slots used in the push buffer */ 242 unsigned int first_get; 243 unsigned int num_slots; 244 245 /* Copy of gathers */ 246 size_t gather_copy_size; 247 dma_addr_t gather_copy; 248 u8 *gather_copy_mapped; 249 250 /* Check if register is marked as an address reg */ 251 int (*is_addr_reg)(struct device *dev, u32 class, u32 reg); 252 253 /* Check if class belongs to the unit */ 254 int (*is_valid_class)(u32 class); 255 256 /* Request a SETCLASS to this class */ 257 u32 class; 258 259 /* Add a channel wait for previous ops to complete */ 260 bool serialize; 261 }; 262 263 struct host1x_job *host1x_job_alloc(struct host1x_channel *ch, 264 u32 num_cmdbufs, u32 num_relocs, 265 u32 num_waitchks); 266 void host1x_job_add_gather(struct host1x_job *job, struct host1x_bo *mem_id, 267 u32 words, u32 offset); 268 struct host1x_job *host1x_job_get(struct host1x_job *job); 269 void host1x_job_put(struct host1x_job *job); 270 int host1x_job_pin(struct host1x_job *job, struct device *dev); 271 void host1x_job_unpin(struct host1x_job *job); 272 273 /* 274 * subdevice probe infrastructure 275 */ 276 277 struct host1x_device; 278 279 /** 280 * struct host1x_driver - host1x logical device driver 281 * @driver: core driver 282 * @subdevs: table of OF device IDs matching subdevices for this driver 283 * @list: list node for the driver 284 * @probe: called when the host1x logical device is probed 285 * @remove: called when the host1x logical device is removed 286 * @shutdown: called when the host1x logical device is shut down 287 */ 288 struct host1x_driver { 289 struct device_driver driver; 290 291 const struct of_device_id *subdevs; 292 struct list_head list; 293 294 int (*probe)(struct host1x_device *device); 295 int (*remove)(struct host1x_device *device); 296 void (*shutdown)(struct host1x_device *device); 297 }; 298 299 static inline struct host1x_driver * 300 to_host1x_driver(struct device_driver *driver) 301 { 302 return container_of(driver, struct host1x_driver, driver); 303 } 304 305 int host1x_driver_register_full(struct host1x_driver *driver, 306 struct module *owner); 307 void host1x_driver_unregister(struct host1x_driver *driver); 308 309 #define host1x_driver_register(driver) \ 310 host1x_driver_register_full(driver, THIS_MODULE) 311 312 struct host1x_device { 313 struct host1x_driver *driver; 314 struct list_head list; 315 struct device dev; 316 317 struct mutex subdevs_lock; 318 struct list_head subdevs; 319 struct list_head active; 320 321 struct mutex clients_lock; 322 struct list_head clients; 323 324 bool registered; 325 }; 326 327 static inline struct host1x_device *to_host1x_device(struct device *dev) 328 { 329 return container_of(dev, struct host1x_device, dev); 330 } 331 332 int host1x_device_init(struct host1x_device *device); 333 int host1x_device_exit(struct host1x_device *device); 334 335 int host1x_client_register(struct host1x_client *client); 336 int host1x_client_unregister(struct host1x_client *client); 337 338 struct tegra_mipi_device; 339 340 struct tegra_mipi_device *tegra_mipi_request(struct device *device); 341 void tegra_mipi_free(struct tegra_mipi_device *device); 342 int tegra_mipi_enable(struct tegra_mipi_device *device); 343 int tegra_mipi_disable(struct tegra_mipi_device *device); 344 int tegra_mipi_calibrate(struct tegra_mipi_device *device); 345 346 #endif 347