1d2912cb1SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
242bd6f59SJacek Anaszewski /*
342bd6f59SJacek Anaszewski * V4L2 flash LED sub-device registration helpers.
442bd6f59SJacek Anaszewski *
542bd6f59SJacek Anaszewski * Copyright (C) 2015 Samsung Electronics Co., Ltd
642bd6f59SJacek Anaszewski * Author: Jacek Anaszewski <j.anaszewski@samsung.com>
742bd6f59SJacek Anaszewski */
842bd6f59SJacek Anaszewski
942bd6f59SJacek Anaszewski #ifndef _V4L2_FLASH_H
1042bd6f59SJacek Anaszewski #define _V4L2_FLASH_H
1142bd6f59SJacek Anaszewski
1242bd6f59SJacek Anaszewski #include <media/v4l2-ctrls.h>
1342bd6f59SJacek Anaszewski #include <media/v4l2-subdev.h>
1442bd6f59SJacek Anaszewski
1542bd6f59SJacek Anaszewski struct led_classdev_flash;
1642bd6f59SJacek Anaszewski struct led_classdev;
1742bd6f59SJacek Anaszewski struct v4l2_flash;
1842bd6f59SJacek Anaszewski enum led_brightness;
1942bd6f59SJacek Anaszewski
200d56015dSMauro Carvalho Chehab /**
2142bd6f59SJacek Anaszewski * struct v4l2_flash_ctrl_data - flash control initialization data, filled
2242bd6f59SJacek Anaszewski * basing on the features declared by the LED flash
2342bd6f59SJacek Anaszewski * class driver in the v4l2_flash_config
2442bd6f59SJacek Anaszewski * @config: initialization data for a control
2542bd6f59SJacek Anaszewski * @cid: contains v4l2 flash control id if the config
2642bd6f59SJacek Anaszewski * field was initialized, 0 otherwise
2742bd6f59SJacek Anaszewski */
2842bd6f59SJacek Anaszewski struct v4l2_flash_ctrl_data {
2942bd6f59SJacek Anaszewski struct v4l2_ctrl_config config;
3042bd6f59SJacek Anaszewski u32 cid;
3142bd6f59SJacek Anaszewski };
3242bd6f59SJacek Anaszewski
330d56015dSMauro Carvalho Chehab /**
340d56015dSMauro Carvalho Chehab * struct v4l2_flash_ops - V4L2 flash operations
350d56015dSMauro Carvalho Chehab *
360d56015dSMauro Carvalho Chehab * @external_strobe_set: Setup strobing the flash by hardware pin state
370d56015dSMauro Carvalho Chehab * assertion.
380d56015dSMauro Carvalho Chehab * @intensity_to_led_brightness: Convert intensity to brightness in a device
390d56015dSMauro Carvalho Chehab * specific manner
400d56015dSMauro Carvalho Chehab * @led_brightness_to_intensity: convert brightness to intensity in a device
410d56015dSMauro Carvalho Chehab * specific manner.
420d56015dSMauro Carvalho Chehab */
4342bd6f59SJacek Anaszewski struct v4l2_flash_ops {
4442bd6f59SJacek Anaszewski int (*external_strobe_set)(struct v4l2_flash *v4l2_flash,
4542bd6f59SJacek Anaszewski bool enable);
4642bd6f59SJacek Anaszewski enum led_brightness (*intensity_to_led_brightness)
4742bd6f59SJacek Anaszewski (struct v4l2_flash *v4l2_flash, s32 intensity);
4842bd6f59SJacek Anaszewski s32 (*led_brightness_to_intensity)
4942bd6f59SJacek Anaszewski (struct v4l2_flash *v4l2_flash, enum led_brightness);
5042bd6f59SJacek Anaszewski };
5142bd6f59SJacek Anaszewski
5242bd6f59SJacek Anaszewski /**
5342bd6f59SJacek Anaszewski * struct v4l2_flash_config - V4L2 Flash sub-device initialization data
5442bd6f59SJacek Anaszewski * @dev_name: the name of the media entity,
5562ba6b22SMauro Carvalho Chehab * unique in the system
56503dd28aSSakari Ailus * @intensity: non-flash strobe constraints for the LED
5742bd6f59SJacek Anaszewski * @flash_faults: bitmask of flash faults that the LED flash class
5862ba6b22SMauro Carvalho Chehab * device can report; corresponding LED_FAULT* bit
5962ba6b22SMauro Carvalho Chehab * definitions are available in the header file
6062ba6b22SMauro Carvalho Chehab * <linux/led-class-flash.h>
6142bd6f59SJacek Anaszewski * @has_external_strobe: external strobe capability
6242bd6f59SJacek Anaszewski */
6342bd6f59SJacek Anaszewski struct v4l2_flash_config {
6442bd6f59SJacek Anaszewski char dev_name[32];
65503dd28aSSakari Ailus struct led_flash_setting intensity;
6642bd6f59SJacek Anaszewski u32 flash_faults;
6742bd6f59SJacek Anaszewski unsigned int has_external_strobe:1;
6842bd6f59SJacek Anaszewski };
6942bd6f59SJacek Anaszewski
7042bd6f59SJacek Anaszewski /**
7142bd6f59SJacek Anaszewski * struct v4l2_flash - Flash sub-device context
7242bd6f59SJacek Anaszewski * @fled_cdev: LED flash class device controlled by this sub-device
7342bd6f59SJacek Anaszewski * @iled_cdev: LED class device representing indicator LED associated
7442bd6f59SJacek Anaszewski * with the LED flash class device
7542bd6f59SJacek Anaszewski * @ops: V4L2 specific flash ops
7642bd6f59SJacek Anaszewski * @sd: V4L2 sub-device
7742bd6f59SJacek Anaszewski * @hdl: flash controls handler
7842bd6f59SJacek Anaszewski * @ctrls: array of pointers to controls, whose values define
7942bd6f59SJacek Anaszewski * the sub-device state
8042bd6f59SJacek Anaszewski */
8142bd6f59SJacek Anaszewski struct v4l2_flash {
8242bd6f59SJacek Anaszewski struct led_classdev_flash *fled_cdev;
8385f7ff97SSakari Ailus struct led_classdev *iled_cdev;
8442bd6f59SJacek Anaszewski const struct v4l2_flash_ops *ops;
8542bd6f59SJacek Anaszewski
8642bd6f59SJacek Anaszewski struct v4l2_subdev sd;
8742bd6f59SJacek Anaszewski struct v4l2_ctrl_handler hdl;
8842bd6f59SJacek Anaszewski struct v4l2_ctrl **ctrls;
8942bd6f59SJacek Anaszewski };
9042bd6f59SJacek Anaszewski
91716b8764SMauro Carvalho Chehab /**
92716b8764SMauro Carvalho Chehab * v4l2_subdev_to_v4l2_flash - Returns a &struct v4l2_flash from the
93716b8764SMauro Carvalho Chehab * &struct v4l2_subdev embedded on it.
94716b8764SMauro Carvalho Chehab *
95716b8764SMauro Carvalho Chehab * @sd: pointer to &struct v4l2_subdev
96716b8764SMauro Carvalho Chehab */
v4l2_subdev_to_v4l2_flash(struct v4l2_subdev * sd)9742bd6f59SJacek Anaszewski static inline struct v4l2_flash *v4l2_subdev_to_v4l2_flash(
9842bd6f59SJacek Anaszewski struct v4l2_subdev *sd)
9942bd6f59SJacek Anaszewski {
10042bd6f59SJacek Anaszewski return container_of(sd, struct v4l2_flash, sd);
10142bd6f59SJacek Anaszewski }
10242bd6f59SJacek Anaszewski
103716b8764SMauro Carvalho Chehab /**
104716b8764SMauro Carvalho Chehab * v4l2_ctrl_to_v4l2_flash - Returns a &struct v4l2_flash from the
105716b8764SMauro Carvalho Chehab * &struct v4l2_ctrl embedded on it.
106716b8764SMauro Carvalho Chehab *
107716b8764SMauro Carvalho Chehab * @c: pointer to &struct v4l2_ctrl
108716b8764SMauro Carvalho Chehab */
v4l2_ctrl_to_v4l2_flash(struct v4l2_ctrl * c)10942bd6f59SJacek Anaszewski static inline struct v4l2_flash *v4l2_ctrl_to_v4l2_flash(struct v4l2_ctrl *c)
11042bd6f59SJacek Anaszewski {
11142bd6f59SJacek Anaszewski return container_of(c->handler, struct v4l2_flash, hdl);
11242bd6f59SJacek Anaszewski }
11342bd6f59SJacek Anaszewski
11442bd6f59SJacek Anaszewski #if IS_ENABLED(CONFIG_V4L2_FLASH_LED_CLASS)
11542bd6f59SJacek Anaszewski /**
11642bd6f59SJacek Anaszewski * v4l2_flash_init - initialize V4L2 flash led sub-device
11742bd6f59SJacek Anaszewski * @dev: flash device, e.g. an I2C device
118048ea05bSSakari Ailus * @fwn: fwnode_handle of the LED, may be NULL if the same as device's
11942bd6f59SJacek Anaszewski * @fled_cdev: LED flash class device to wrap
12062ba6b22SMauro Carvalho Chehab * @ops: V4L2 Flash device ops
12142bd6f59SJacek Anaszewski * @config: initialization data for V4L2 Flash sub-device
12242bd6f59SJacek Anaszewski *
12342bd6f59SJacek Anaszewski * Create V4L2 Flash sub-device wrapping given LED subsystem device.
12440cefffdSSakari Ailus * The ops pointer is stored by the V4L2 flash framework. No
12540cefffdSSakari Ailus * references are held to config nor its contents once this function
12640cefffdSSakari Ailus * has returned.
12742bd6f59SJacek Anaszewski *
12842bd6f59SJacek Anaszewski * Returns: A valid pointer, or, when an error occurs, the return
12942bd6f59SJacek Anaszewski * value is encoded using ERR_PTR(). Use IS_ERR() to check and
13042bd6f59SJacek Anaszewski * PTR_ERR() to obtain the numeric return value.
13142bd6f59SJacek Anaszewski */
13242bd6f59SJacek Anaszewski struct v4l2_flash *v4l2_flash_init(
133048ea05bSSakari Ailus struct device *dev, struct fwnode_handle *fwn,
13442bd6f59SJacek Anaszewski struct led_classdev_flash *fled_cdev,
135503dd28aSSakari Ailus const struct v4l2_flash_ops *ops, struct v4l2_flash_config *config);
136503dd28aSSakari Ailus
137503dd28aSSakari Ailus /**
138503dd28aSSakari Ailus * v4l2_flash_indicator_init - initialize V4L2 indicator sub-device
139503dd28aSSakari Ailus * @dev: flash device, e.g. an I2C device
140503dd28aSSakari Ailus * @fwn: fwnode_handle of the LED, may be NULL if the same as device's
141503dd28aSSakari Ailus * @iled_cdev: LED flash class device representing the indicator LED
142503dd28aSSakari Ailus * @config: initialization data for V4L2 Flash sub-device
143503dd28aSSakari Ailus *
144503dd28aSSakari Ailus * Create V4L2 Flash sub-device wrapping given LED subsystem device.
14540cefffdSSakari Ailus * The ops pointer is stored by the V4L2 flash framework. No
14640cefffdSSakari Ailus * references are held to config nor its contents once this function
14740cefffdSSakari Ailus * has returned.
148503dd28aSSakari Ailus *
149503dd28aSSakari Ailus * Returns: A valid pointer, or, when an error occurs, the return
150503dd28aSSakari Ailus * value is encoded using ERR_PTR(). Use IS_ERR() to check and
151503dd28aSSakari Ailus * PTR_ERR() to obtain the numeric return value.
152503dd28aSSakari Ailus */
153503dd28aSSakari Ailus struct v4l2_flash *v4l2_flash_indicator_init(
154503dd28aSSakari Ailus struct device *dev, struct fwnode_handle *fwn,
155503dd28aSSakari Ailus struct led_classdev *iled_cdev, struct v4l2_flash_config *config);
15642bd6f59SJacek Anaszewski
15742bd6f59SJacek Anaszewski /**
15842bd6f59SJacek Anaszewski * v4l2_flash_release - release V4L2 Flash sub-device
15962ba6b22SMauro Carvalho Chehab * @v4l2_flash: the V4L2 Flash sub-device to release
16042bd6f59SJacek Anaszewski *
16142bd6f59SJacek Anaszewski * Release V4L2 Flash sub-device.
16242bd6f59SJacek Anaszewski */
16342bd6f59SJacek Anaszewski void v4l2_flash_release(struct v4l2_flash *v4l2_flash);
16442bd6f59SJacek Anaszewski
16542bd6f59SJacek Anaszewski #else
v4l2_flash_init(struct device * dev,struct fwnode_handle * fwn,struct led_classdev_flash * fled_cdev,const struct v4l2_flash_ops * ops,struct v4l2_flash_config * config)16642bd6f59SJacek Anaszewski static inline struct v4l2_flash *v4l2_flash_init(
167048ea05bSSakari Ailus struct device *dev, struct fwnode_handle *fwn,
16842bd6f59SJacek Anaszewski struct led_classdev_flash *fled_cdev,
169503dd28aSSakari Ailus const struct v4l2_flash_ops *ops, struct v4l2_flash_config *config)
170503dd28aSSakari Ailus {
171503dd28aSSakari Ailus return NULL;
172503dd28aSSakari Ailus }
173503dd28aSSakari Ailus
v4l2_flash_indicator_init(struct device * dev,struct fwnode_handle * fwn,struct led_classdev * iled_cdev,struct v4l2_flash_config * config)174503dd28aSSakari Ailus static inline struct v4l2_flash *v4l2_flash_indicator_init(
175503dd28aSSakari Ailus struct device *dev, struct fwnode_handle *fwn,
176503dd28aSSakari Ailus struct led_classdev *iled_cdev, struct v4l2_flash_config *config)
17742bd6f59SJacek Anaszewski {
17842bd6f59SJacek Anaszewski return NULL;
17942bd6f59SJacek Anaszewski }
18042bd6f59SJacek Anaszewski
v4l2_flash_release(struct v4l2_flash * v4l2_flash)18142bd6f59SJacek Anaszewski static inline void v4l2_flash_release(struct v4l2_flash *v4l2_flash)
18242bd6f59SJacek Anaszewski {
18342bd6f59SJacek Anaszewski }
18442bd6f59SJacek Anaszewski #endif /* CONFIG_V4L2_FLASH_LED_CLASS */
18542bd6f59SJacek Anaszewski
18642bd6f59SJacek Anaszewski #endif /* _V4L2_FLASH_H */
187