soc_camera.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  1. /*
  2. * camera image capture (abstract) bus driver header
  3. *
  4. * Copyright (C) 2006, Sascha Hauer, Pengutronix
  5. * Copyright (C) 2008, Guennadi Liakhovetski <kernel@pengutronix.de>
  6. *
  7. * This program is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License version 2 as
  9. * published by the Free Software Foundation.
  10. */
  11. #ifndef SOC_CAMERA_H
  12. #define SOC_CAMERA_H
  13. #include <linux/mutex.h>
  14. #include <linux/pm.h>
  15. #include <linux/videodev2.h>
  16. #include <media/videobuf-core.h>
  17. #include <media/v4l2-device.h>
  18. struct soc_camera_device {
  19. struct list_head list;
  20. struct device dev;
  21. struct device *pdev; /* Platform device */
  22. s32 user_width;
  23. s32 user_height;
  24. unsigned short width_min;
  25. unsigned short height_min;
  26. unsigned short y_skip_top; /* Lines to skip at the top */
  27. unsigned char iface; /* Host number */
  28. unsigned char devnum; /* Device number per host */
  29. unsigned char buswidth; /* See comment in .c */
  30. struct soc_camera_sense *sense; /* See comment in struct definition */
  31. struct soc_camera_ops *ops;
  32. struct video_device *vdev;
  33. const struct soc_camera_data_format *current_fmt;
  34. const struct soc_camera_data_format *formats;
  35. int num_formats;
  36. struct soc_camera_format_xlate *user_formats;
  37. int num_user_formats;
  38. enum v4l2_field field; /* Preserve field over close() */
  39. void *host_priv; /* Per-device host private data */
  40. /* soc_camera.c private count. Only accessed with .video_lock held */
  41. int use_count;
  42. struct mutex video_lock; /* Protects device data */
  43. };
  44. struct soc_camera_file {
  45. struct soc_camera_device *icd;
  46. struct videobuf_queue vb_vidq;
  47. };
  48. struct soc_camera_host {
  49. struct v4l2_device v4l2_dev;
  50. struct list_head list;
  51. unsigned char nr; /* Host number */
  52. void *priv;
  53. const char *drv_name;
  54. struct soc_camera_host_ops *ops;
  55. };
  56. struct soc_camera_host_ops {
  57. struct module *owner;
  58. int (*add)(struct soc_camera_device *);
  59. void (*remove)(struct soc_camera_device *);
  60. int (*suspend)(struct soc_camera_device *, pm_message_t);
  61. int (*resume)(struct soc_camera_device *);
  62. /*
  63. * .get_formats() is called for each client device format, but
  64. * .put_formats() is only called once. Further, if any of the calls to
  65. * .get_formats() fail, .put_formats() will not be called at all, the
  66. * failing .get_formats() must then clean up internally.
  67. */
  68. int (*get_formats)(struct soc_camera_device *, int,
  69. struct soc_camera_format_xlate *);
  70. void (*put_formats)(struct soc_camera_device *);
  71. int (*cropcap)(struct soc_camera_device *, struct v4l2_cropcap *);
  72. int (*get_crop)(struct soc_camera_device *, struct v4l2_crop *);
  73. int (*set_crop)(struct soc_camera_device *, struct v4l2_crop *);
  74. int (*set_fmt)(struct soc_camera_device *, struct v4l2_format *);
  75. int (*try_fmt)(struct soc_camera_device *, struct v4l2_format *);
  76. void (*init_videobuf)(struct videobuf_queue *,
  77. struct soc_camera_device *);
  78. int (*reqbufs)(struct soc_camera_file *, struct v4l2_requestbuffers *);
  79. int (*querycap)(struct soc_camera_host *, struct v4l2_capability *);
  80. int (*set_bus_param)(struct soc_camera_device *, __u32);
  81. int (*get_ctrl)(struct soc_camera_device *, struct v4l2_control *);
  82. int (*set_ctrl)(struct soc_camera_device *, struct v4l2_control *);
  83. unsigned int (*poll)(struct file *, poll_table *);
  84. const struct v4l2_queryctrl *controls;
  85. int num_controls;
  86. };
  87. #define SOCAM_SENSOR_INVERT_PCLK (1 << 0)
  88. #define SOCAM_SENSOR_INVERT_MCLK (1 << 1)
  89. #define SOCAM_SENSOR_INVERT_HSYNC (1 << 2)
  90. #define SOCAM_SENSOR_INVERT_VSYNC (1 << 3)
  91. #define SOCAM_SENSOR_INVERT_DATA (1 << 4)
  92. struct i2c_board_info;
  93. struct soc_camera_link {
  94. /* Camera bus id, used to match a camera and a bus */
  95. int bus_id;
  96. /* Per camera SOCAM_SENSOR_* bus flags */
  97. unsigned long flags;
  98. int i2c_adapter_id;
  99. struct i2c_board_info *board_info;
  100. const char *module_name;
  101. /*
  102. * For non-I2C devices platform platform has to provide methods to
  103. * add a device to the system and to remove
  104. */
  105. int (*add_device)(struct soc_camera_link *, struct device *);
  106. void (*del_device)(struct soc_camera_link *);
  107. /* Optional callbacks to power on or off and reset the sensor */
  108. int (*power)(struct device *, int);
  109. int (*reset)(struct device *);
  110. /*
  111. * some platforms may support different data widths than the sensors
  112. * native ones due to different data line routing. Let the board code
  113. * overwrite the width flags.
  114. */
  115. int (*set_bus_param)(struct soc_camera_link *, unsigned long flags);
  116. unsigned long (*query_bus_param)(struct soc_camera_link *);
  117. void (*free_bus)(struct soc_camera_link *);
  118. };
  119. static inline struct soc_camera_device *to_soc_camera_dev(
  120. const struct device *dev)
  121. {
  122. return container_of(dev, struct soc_camera_device, dev);
  123. }
  124. static inline struct soc_camera_host *to_soc_camera_host(
  125. const struct device *dev)
  126. {
  127. struct v4l2_device *v4l2_dev = dev_get_drvdata(dev);
  128. return container_of(v4l2_dev, struct soc_camera_host, v4l2_dev);
  129. }
  130. static inline struct soc_camera_link *to_soc_camera_link(
  131. const struct soc_camera_device *icd)
  132. {
  133. return icd->dev.platform_data;
  134. }
  135. static inline struct device *to_soc_camera_control(
  136. const struct soc_camera_device *icd)
  137. {
  138. return dev_get_drvdata(&icd->dev);
  139. }
  140. static inline struct v4l2_subdev *soc_camera_to_subdev(
  141. const struct soc_camera_device *icd)
  142. {
  143. struct device *control = to_soc_camera_control(icd);
  144. return dev_get_drvdata(control);
  145. }
  146. int soc_camera_host_register(struct soc_camera_host *ici);
  147. void soc_camera_host_unregister(struct soc_camera_host *ici);
  148. const struct soc_camera_data_format *soc_camera_format_by_fourcc(
  149. struct soc_camera_device *icd, unsigned int fourcc);
  150. const struct soc_camera_format_xlate *soc_camera_xlate_by_fourcc(
  151. struct soc_camera_device *icd, unsigned int fourcc);
  152. struct soc_camera_data_format {
  153. const char *name;
  154. unsigned int depth;
  155. __u32 fourcc;
  156. enum v4l2_colorspace colorspace;
  157. };
  158. /**
  159. * struct soc_camera_format_xlate - match between host and sensor formats
  160. * @cam_fmt: sensor format provided by the sensor
  161. * @host_fmt: host format after host translation from cam_fmt
  162. * @buswidth: bus width for this format
  163. *
  164. * Host and sensor translation structure. Used in table of host and sensor
  165. * formats matchings in soc_camera_device. A host can override the generic list
  166. * generation by implementing get_formats(), and use it for format checks and
  167. * format setup.
  168. */
  169. struct soc_camera_format_xlate {
  170. const struct soc_camera_data_format *cam_fmt;
  171. const struct soc_camera_data_format *host_fmt;
  172. unsigned char buswidth;
  173. };
  174. struct soc_camera_ops {
  175. int (*suspend)(struct soc_camera_device *, pm_message_t state);
  176. int (*resume)(struct soc_camera_device *);
  177. unsigned long (*query_bus_param)(struct soc_camera_device *);
  178. int (*set_bus_param)(struct soc_camera_device *, unsigned long);
  179. int (*enum_input)(struct soc_camera_device *, struct v4l2_input *);
  180. const struct v4l2_queryctrl *controls;
  181. int num_controls;
  182. };
  183. #define SOCAM_SENSE_PCLK_CHANGED (1 << 0)
  184. /**
  185. * This struct can be attached to struct soc_camera_device by the host driver
  186. * to request sense from the camera, for example, when calling .set_fmt(). The
  187. * host then can check which flags are set and verify respective values if any.
  188. * For example, if SOCAM_SENSE_PCLK_CHANGED is set, it means, pixclock has
  189. * changed during this operation. After completion the host should detach sense.
  190. *
  191. * @flags ored SOCAM_SENSE_* flags
  192. * @master_clock if the host wants to be informed about pixel-clock
  193. * change, it better set master_clock.
  194. * @pixel_clock_max maximum pixel clock frequency supported by the host,
  195. * camera is not allowed to exceed this.
  196. * @pixel_clock if the camera driver changed pixel clock during this
  197. * operation, it sets SOCAM_SENSE_PCLK_CHANGED, uses
  198. * master_clock to calculate the new pixel-clock and
  199. * sets this field.
  200. */
  201. struct soc_camera_sense {
  202. unsigned long flags;
  203. unsigned long master_clock;
  204. unsigned long pixel_clock_max;
  205. unsigned long pixel_clock;
  206. };
  207. static inline struct v4l2_queryctrl const *soc_camera_find_qctrl(
  208. struct soc_camera_ops *ops, int id)
  209. {
  210. int i;
  211. for (i = 0; i < ops->num_controls; i++)
  212. if (ops->controls[i].id == id)
  213. return &ops->controls[i];
  214. return NULL;
  215. }
  216. #define SOCAM_MASTER (1 << 0)
  217. #define SOCAM_SLAVE (1 << 1)
  218. #define SOCAM_HSYNC_ACTIVE_HIGH (1 << 2)
  219. #define SOCAM_HSYNC_ACTIVE_LOW (1 << 3)
  220. #define SOCAM_VSYNC_ACTIVE_HIGH (1 << 4)
  221. #define SOCAM_VSYNC_ACTIVE_LOW (1 << 5)
  222. #define SOCAM_DATAWIDTH_4 (1 << 6)
  223. #define SOCAM_DATAWIDTH_8 (1 << 7)
  224. #define SOCAM_DATAWIDTH_9 (1 << 8)
  225. #define SOCAM_DATAWIDTH_10 (1 << 9)
  226. #define SOCAM_DATAWIDTH_15 (1 << 10)
  227. #define SOCAM_DATAWIDTH_16 (1 << 11)
  228. #define SOCAM_PCLK_SAMPLE_RISING (1 << 12)
  229. #define SOCAM_PCLK_SAMPLE_FALLING (1 << 13)
  230. #define SOCAM_DATA_ACTIVE_HIGH (1 << 14)
  231. #define SOCAM_DATA_ACTIVE_LOW (1 << 15)
  232. #define SOCAM_DATAWIDTH_MASK (SOCAM_DATAWIDTH_4 | SOCAM_DATAWIDTH_8 | \
  233. SOCAM_DATAWIDTH_9 | SOCAM_DATAWIDTH_10 | \
  234. SOCAM_DATAWIDTH_15 | SOCAM_DATAWIDTH_16)
  235. static inline unsigned long soc_camera_bus_param_compatible(
  236. unsigned long camera_flags, unsigned long bus_flags)
  237. {
  238. unsigned long common_flags, hsync, vsync, pclk, data, buswidth, mode;
  239. common_flags = camera_flags & bus_flags;
  240. hsync = common_flags & (SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_LOW);
  241. vsync = common_flags & (SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_LOW);
  242. pclk = common_flags & (SOCAM_PCLK_SAMPLE_RISING | SOCAM_PCLK_SAMPLE_FALLING);
  243. data = common_flags & (SOCAM_DATA_ACTIVE_HIGH | SOCAM_DATA_ACTIVE_LOW);
  244. mode = common_flags & (SOCAM_MASTER | SOCAM_SLAVE);
  245. buswidth = common_flags & SOCAM_DATAWIDTH_MASK;
  246. return (!hsync || !vsync || !pclk || !data || !mode || !buswidth) ? 0 :
  247. common_flags;
  248. }
  249. static inline void soc_camera_limit_side(unsigned int *start,
  250. unsigned int *length, unsigned int start_min,
  251. unsigned int length_min, unsigned int length_max)
  252. {
  253. if (*length < length_min)
  254. *length = length_min;
  255. else if (*length > length_max)
  256. *length = length_max;
  257. if (*start < start_min)
  258. *start = start_min;
  259. else if (*start > start_min + length_max - *length)
  260. *start = start_min + length_max - *length;
  261. }
  262. extern unsigned long soc_camera_apply_sensor_flags(struct soc_camera_link *icl,
  263. unsigned long flags);
  264. #endif