16e1d824eSShuah Khan /* SPDX-License-Identifier: GPL-2.0+ */
26e1d824eSShuah Khan /*
36e1d824eSShuah Khan * media-dev-allocator.h - Media Controller Device Allocator API
46e1d824eSShuah Khan *
56e1d824eSShuah Khan * Copyright (c) 2019 Shuah Khan <shuah@kernel.org>
66e1d824eSShuah Khan *
76e1d824eSShuah Khan * Credits: Suggested by Laurent Pinchart <laurent.pinchart@ideasonboard.com>
86e1d824eSShuah Khan */
96e1d824eSShuah Khan
106e1d824eSShuah Khan /*
116e1d824eSShuah Khan * This file adds a global ref-counted Media Controller Device Instance API.
126e1d824eSShuah Khan * A system wide global media device list is managed and each media device
136e1d824eSShuah Khan * includes a kref count. The last put on the media device releases the media
146e1d824eSShuah Khan * device instance.
156e1d824eSShuah Khan */
166e1d824eSShuah Khan
176e1d824eSShuah Khan #ifndef _MEDIA_DEV_ALLOCATOR_H
186e1d824eSShuah Khan #define _MEDIA_DEV_ALLOCATOR_H
196e1d824eSShuah Khan
206e1d824eSShuah Khan struct usb_device;
216e1d824eSShuah Khan
22*50e7a31dSShuah Khan #if defined(CONFIG_MEDIA_CONTROLLER) && IS_ENABLED(CONFIG_USB)
236e1d824eSShuah Khan /**
246e1d824eSShuah Khan * media_device_usb_allocate() - Allocate and return struct &media device
256e1d824eSShuah Khan *
266e1d824eSShuah Khan * @udev: struct &usb_device pointer
276e1d824eSShuah Khan * @module_name: should be filled with %KBUILD_MODNAME
286e1d824eSShuah Khan * @owner: struct module pointer %THIS_MODULE for the driver.
296e1d824eSShuah Khan * %THIS_MODULE is null for a built-in driver.
306e1d824eSShuah Khan * It is safe even when %THIS_MODULE is null.
316e1d824eSShuah Khan *
326e1d824eSShuah Khan * This interface should be called to allocate a Media Device when multiple
336e1d824eSShuah Khan * drivers share usb_device and the media device. This interface allocates
346e1d824eSShuah Khan * &media_device structure and calls media_device_usb_init() to initialize
356e1d824eSShuah Khan * it.
366e1d824eSShuah Khan *
376e1d824eSShuah Khan */
386e1d824eSShuah Khan struct media_device *media_device_usb_allocate(struct usb_device *udev,
396e1d824eSShuah Khan const char *module_name,
406e1d824eSShuah Khan struct module *owner);
416e1d824eSShuah Khan /**
426e1d824eSShuah Khan * media_device_delete() - Release media device. Calls kref_put().
436e1d824eSShuah Khan *
446e1d824eSShuah Khan * @mdev: struct &media_device pointer
456e1d824eSShuah Khan * @module_name: should be filled with %KBUILD_MODNAME
466e1d824eSShuah Khan * @owner: struct module pointer %THIS_MODULE for the driver.
476e1d824eSShuah Khan * %THIS_MODULE is null for a built-in driver.
486e1d824eSShuah Khan * It is safe even when %THIS_MODULE is null.
496e1d824eSShuah Khan *
506e1d824eSShuah Khan * This interface should be called to put Media Device Instance kref.
516e1d824eSShuah Khan */
526e1d824eSShuah Khan void media_device_delete(struct media_device *mdev, const char *module_name,
536e1d824eSShuah Khan struct module *owner);
546e1d824eSShuah Khan #else
media_device_usb_allocate(struct usb_device * udev,const char * module_name,struct module * owner)556e1d824eSShuah Khan static inline struct media_device *media_device_usb_allocate(
566e1d824eSShuah Khan struct usb_device *udev, const char *module_name,
576e1d824eSShuah Khan struct module *owner)
586e1d824eSShuah Khan { return NULL; }
media_device_delete(struct media_device * mdev,const char * module_name,struct module * owner)596e1d824eSShuah Khan static inline void media_device_delete(
606e1d824eSShuah Khan struct media_device *mdev, const char *module_name,
616e1d824eSShuah Khan struct module *owner) { }
626e1d824eSShuah Khan #endif /* CONFIG_MEDIA_CONTROLLER && CONFIG_USB */
636e1d824eSShuah Khan #endif /* _MEDIA_DEV_ALLOCATOR_H */
64