xref: /netbsd-src/sys/external/bsd/drm2/i2c/drm_encoder_slave.c (revision 89ff363a0bbf0d37d54cca1079138521c5698709)
1*89ff363aSriastradh /*	$NetBSD: drm_encoder_slave.c,v 1.2 2021/12/19 10:48:14 riastradh Exp $	*/
2c48dc052Sriastradh 
3c48dc052Sriastradh /*-
4c48dc052Sriastradh  * Copyright (c) 2015 The NetBSD Foundation, Inc.
5c48dc052Sriastradh  * All rights reserved.
6c48dc052Sriastradh  *
7c48dc052Sriastradh  * This code is derived from software contributed to The NetBSD Foundation
8c48dc052Sriastradh  * by Taylor R. Campbell.
9c48dc052Sriastradh  *
10c48dc052Sriastradh  * Redistribution and use in source and binary forms, with or without
11c48dc052Sriastradh  * modification, are permitted provided that the following conditions
12c48dc052Sriastradh  * are met:
13c48dc052Sriastradh  * 1. Redistributions of source code must retain the above copyright
14c48dc052Sriastradh  *    notice, this list of conditions and the following disclaimer.
15c48dc052Sriastradh  * 2. Redistributions in binary form must reproduce the above copyright
16c48dc052Sriastradh  *    notice, this list of conditions and the following disclaimer in the
17c48dc052Sriastradh  *    documentation and/or other materials provided with the distribution.
18c48dc052Sriastradh  *
19c48dc052Sriastradh  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20c48dc052Sriastradh  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21c48dc052Sriastradh  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22c48dc052Sriastradh  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23c48dc052Sriastradh  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24c48dc052Sriastradh  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25c48dc052Sriastradh  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26c48dc052Sriastradh  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27c48dc052Sriastradh  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28c48dc052Sriastradh  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29c48dc052Sriastradh  * POSSIBILITY OF SUCH DAMAGE.
30c48dc052Sriastradh  */
31c48dc052Sriastradh 
32c48dc052Sriastradh #include <sys/cdefs.h>
33*89ff363aSriastradh __KERNEL_RCSID(0, "$NetBSD: drm_encoder_slave.c,v 1.2 2021/12/19 10:48:14 riastradh Exp $");
34c48dc052Sriastradh 
35c48dc052Sriastradh #include <sys/types.h>
36c48dc052Sriastradh #include <sys/atomic.h>
37c48dc052Sriastradh #include <sys/errno.h>
38c48dc052Sriastradh #include <sys/kmem.h>
39c48dc052Sriastradh #include <sys/mutex.h>
40c48dc052Sriastradh #include <sys/rbtree.h>
41c48dc052Sriastradh #include <sys/systm.h>
42c48dc052Sriastradh 
43c48dc052Sriastradh #include <linux/i2c.h>
44c48dc052Sriastradh 
45c48dc052Sriastradh #include <drm/drm_encoder_slave.h>
46c48dc052Sriastradh 
47c48dc052Sriastradh static struct {
48c48dc052Sriastradh 	kmutex_t	lock;
49c48dc052Sriastradh 	rb_tree_t	tree;	/* struct drm_i2c_encoder_driver */
50c48dc052Sriastradh } drm_i2c_encoder_drivers;
51c48dc052Sriastradh 
52c48dc052Sriastradh static int
compare_i2c_encoders(void * cookie __unused,const void * va,const void * vb)53c48dc052Sriastradh compare_i2c_encoders(void *cookie __unused, const void *va, const void *vb)
54c48dc052Sriastradh {
55c48dc052Sriastradh 	const struct drm_i2c_encoder_driver *const da = va;
56c48dc052Sriastradh 	const struct drm_i2c_encoder_driver *const db = vb;
57c48dc052Sriastradh 
58c48dc052Sriastradh 	return strncmp(da->i2c_driver.driver.name, db->i2c_driver.driver.name,
59c48dc052Sriastradh 	    I2C_NAME_SIZE);
60c48dc052Sriastradh }
61c48dc052Sriastradh 
62c48dc052Sriastradh static int
compare_i2c_encoder_key(void * cookie __unused,const void * n,const void * k)63c48dc052Sriastradh compare_i2c_encoder_key(void *cookie __unused, const void *n, const void *k)
64c48dc052Sriastradh {
65c48dc052Sriastradh 	const struct drm_i2c_encoder_driver *const driver = n;
66c48dc052Sriastradh 	const char *const name = k;
67c48dc052Sriastradh 
68c48dc052Sriastradh 	return strncmp(driver->i2c_driver.driver.name, name, I2C_NAME_SIZE);
69c48dc052Sriastradh }
70c48dc052Sriastradh 
71c48dc052Sriastradh static rb_tree_ops_t drm_i2c_encoder_rb_ops = {
72c48dc052Sriastradh 	.rbto_compare_nodes = &compare_i2c_encoders,
73c48dc052Sriastradh 	.rbto_compare_key = &compare_i2c_encoder_key,
74c48dc052Sriastradh 	.rbto_node_offset = offsetof(struct drm_i2c_encoder_driver, rb_node),
75c48dc052Sriastradh 	.rbto_context = NULL,
76c48dc052Sriastradh };
77c48dc052Sriastradh 
78c48dc052Sriastradh void
drm_i2c_encoders_init(void)79c48dc052Sriastradh drm_i2c_encoders_init(void)
80c48dc052Sriastradh {
81c48dc052Sriastradh 
82c48dc052Sriastradh 	mutex_init(&drm_i2c_encoder_drivers.lock, MUTEX_DEFAULT, IPL_NONE);
83c48dc052Sriastradh 	rb_tree_init(&drm_i2c_encoder_drivers.tree, &drm_i2c_encoder_rb_ops);
84c48dc052Sriastradh }
85c48dc052Sriastradh 
86c48dc052Sriastradh void
drm_i2c_encoders_fini(void)87c48dc052Sriastradh drm_i2c_encoders_fini(void)
88c48dc052Sriastradh {
89c48dc052Sriastradh 
90c48dc052Sriastradh 	KASSERT(RB_TREE_MIN(&drm_i2c_encoder_drivers.tree) == NULL);
91c48dc052Sriastradh #if 0				/* XXX no rb_tree_destroy */
92c48dc052Sriastradh 	rb_tree_destroy(&drm_i2c_encoder_drivers.tree);
93c48dc052Sriastradh #endif
94c48dc052Sriastradh 	mutex_destroy(&drm_i2c_encoder_drivers.lock);
95c48dc052Sriastradh }
96c48dc052Sriastradh 
97c48dc052Sriastradh int
drm_i2c_encoder_register(struct module * owner __unused,struct drm_i2c_encoder_driver * driver)98c48dc052Sriastradh drm_i2c_encoder_register(struct module *owner __unused,
99c48dc052Sriastradh     struct drm_i2c_encoder_driver *driver)
100c48dc052Sriastradh {
101c48dc052Sriastradh 	struct drm_i2c_encoder_driver *collision;
102c48dc052Sriastradh 	int ret = 0;
103c48dc052Sriastradh 
104c48dc052Sriastradh 	mutex_enter(&drm_i2c_encoder_drivers.lock);
105c48dc052Sriastradh 	collision = rb_tree_insert_node(&drm_i2c_encoder_drivers.tree, driver);
106c48dc052Sriastradh 	if (collision != driver)
107c48dc052Sriastradh 		ret = -EEXIST;
108c48dc052Sriastradh 	mutex_exit(&drm_i2c_encoder_drivers.lock);
109c48dc052Sriastradh 
110c48dc052Sriastradh 	return ret;
111c48dc052Sriastradh }
112c48dc052Sriastradh 
113c48dc052Sriastradh void
drm_i2c_encoder_unregister(struct drm_i2c_encoder_driver * driver)114c48dc052Sriastradh drm_i2c_encoder_unregister(struct drm_i2c_encoder_driver *driver)
115c48dc052Sriastradh {
116c48dc052Sriastradh 
117c48dc052Sriastradh 	/* XXX How to guarantee?  */
118c48dc052Sriastradh 	KASSERT(driver->refcnt == 0);
119c48dc052Sriastradh 
120c48dc052Sriastradh 	mutex_enter(&drm_i2c_encoder_drivers.lock);
121c48dc052Sriastradh 	rb_tree_remove_node(&drm_i2c_encoder_drivers.tree, driver);
122c48dc052Sriastradh 	mutex_exit(&drm_i2c_encoder_drivers.lock);
123c48dc052Sriastradh }
124c48dc052Sriastradh 
125c48dc052Sriastradh struct drm_i2c_encoder_bus_priv {
126c48dc052Sriastradh 	struct i2c_client		*i2c_client;
127c48dc052Sriastradh 	struct drm_i2c_encoder_driver	*i2c_driver;
128c48dc052Sriastradh };
129c48dc052Sriastradh 
130c48dc052Sriastradh int
drm_i2c_encoder_init(struct drm_device * dev,struct drm_encoder_slave * slave,struct i2c_adapter * adapter,const struct i2c_board_info * info)131c48dc052Sriastradh drm_i2c_encoder_init(struct drm_device *dev, struct drm_encoder_slave *slave,
132c48dc052Sriastradh     struct i2c_adapter *adapter, const struct i2c_board_info *info)
133c48dc052Sriastradh {
134c48dc052Sriastradh 	struct drm_i2c_encoder_driver *driver;
135c48dc052Sriastradh 	struct drm_i2c_encoder_bus_priv *bus_priv;
136c48dc052Sriastradh 	struct i2c_client *client;
137c48dc052Sriastradh 	unsigned refcnt;
138c48dc052Sriastradh 	int ret;
139c48dc052Sriastradh 
140c48dc052Sriastradh 	bus_priv = kmem_alloc(sizeof(*bus_priv), KM_SLEEP);
141c48dc052Sriastradh 	slave->bus_priv = bus_priv;
142c48dc052Sriastradh 
143c48dc052Sriastradh 	mutex_enter(&drm_i2c_encoder_drivers.lock);
144c48dc052Sriastradh 	driver = rb_tree_find_node(&drm_i2c_encoder_drivers.tree, info->type);
145c48dc052Sriastradh 	mutex_exit(&drm_i2c_encoder_drivers.lock);
146c48dc052Sriastradh 	if (driver == NULL) {
147c48dc052Sriastradh 		ret = -ENODEV;
148c48dc052Sriastradh 		goto fail0;
149c48dc052Sriastradh 	}
150c48dc052Sriastradh 	do {
151c48dc052Sriastradh 		refcnt = driver->refcnt;
152c48dc052Sriastradh 		if (refcnt == UINT_MAX) {
153c48dc052Sriastradh 			ret = -ENFILE;
154c48dc052Sriastradh 			goto fail0;
155c48dc052Sriastradh 		}
156c48dc052Sriastradh 	} while (atomic_cas_uint(&driver->refcnt, refcnt, refcnt + 1)
157c48dc052Sriastradh 	    != refcnt);
158c48dc052Sriastradh 	bus_priv->i2c_driver = driver;
159c48dc052Sriastradh 
160c48dc052Sriastradh 	client = i2c_new_device(adapter, info);
161c48dc052Sriastradh 	KASSERT(client != NULL);
162c48dc052Sriastradh 	bus_priv->i2c_client = client;
163c48dc052Sriastradh 
164c48dc052Sriastradh 	ret = (*driver->encoder_init)(client, dev, slave);
165c48dc052Sriastradh 	if (ret)
166c48dc052Sriastradh 		goto fail1;
167c48dc052Sriastradh 
168c48dc052Sriastradh 	if (info->platform_data)
169c48dc052Sriastradh 		(*slave->slave_funcs->set_config)(&slave->base,
170c48dc052Sriastradh 		    info->platform_data);
171c48dc052Sriastradh 
172c48dc052Sriastradh 	/* Success!  */
173c48dc052Sriastradh 	return 0;
174c48dc052Sriastradh 
175c48dc052Sriastradh fail1:	bus_priv->i2c_client = NULL;
176c48dc052Sriastradh 	i2c_unregister_device(client);
177c48dc052Sriastradh 	bus_priv->i2c_driver = NULL;
178c48dc052Sriastradh 	atomic_dec_uint(&driver->refcnt);
179c48dc052Sriastradh fail0:	KASSERT(ret < 0);
180c48dc052Sriastradh 	slave->bus_priv = NULL;
181c48dc052Sriastradh 	kmem_free(bus_priv, sizeof(*bus_priv));
182c48dc052Sriastradh 	return ret;
183c48dc052Sriastradh }
184c48dc052Sriastradh 
185c48dc052Sriastradh void
drm_i2c_encoder_destroy(struct drm_encoder * encoder)186c48dc052Sriastradh drm_i2c_encoder_destroy(struct drm_encoder *encoder)
187c48dc052Sriastradh {
188c48dc052Sriastradh 	struct drm_encoder_slave *const slave = to_encoder_slave(encoder);
189c48dc052Sriastradh 	struct drm_i2c_encoder_bus_priv *const bus_priv = slave->bus_priv;
190c48dc052Sriastradh 	struct i2c_client *const client = bus_priv->i2c_client;
191c48dc052Sriastradh 	struct drm_i2c_encoder_driver *const driver = bus_priv->i2c_driver;
192c48dc052Sriastradh 
193c48dc052Sriastradh 	bus_priv->i2c_client = NULL;
194c48dc052Sriastradh 	i2c_unregister_device(client);
195c48dc052Sriastradh 	bus_priv->i2c_driver = NULL;
196c48dc052Sriastradh 	atomic_dec_uint(&driver->refcnt);
197c48dc052Sriastradh }
198c48dc052Sriastradh 
199c48dc052Sriastradh struct i2c_client *
drm_i2c_encoder_get_client(struct drm_encoder * encoder)200c48dc052Sriastradh drm_i2c_encoder_get_client(struct drm_encoder *encoder)
201c48dc052Sriastradh {
202c48dc052Sriastradh 	struct drm_encoder_slave *const slave = to_encoder_slave(encoder);
203c48dc052Sriastradh 	struct drm_i2c_encoder_bus_priv *const bus_priv = slave->bus_priv;
204c48dc052Sriastradh 
205c48dc052Sriastradh 	return bus_priv->i2c_client;
206c48dc052Sriastradh }
207c48dc052Sriastradh 
208*89ff363aSriastradh static inline const struct drm_encoder_slave_funcs *
slave_funcs(struct drm_encoder * encoder)209c48dc052Sriastradh slave_funcs(struct drm_encoder *encoder)
210c48dc052Sriastradh {
211c48dc052Sriastradh 
212c48dc052Sriastradh 	return to_encoder_slave(encoder)->slave_funcs;
213c48dc052Sriastradh }
214c48dc052Sriastradh 
215c48dc052Sriastradh void
drm_i2c_encoder_dpms(struct drm_encoder * encoder,int mode)216c48dc052Sriastradh drm_i2c_encoder_dpms(struct drm_encoder *encoder, int mode)
217c48dc052Sriastradh {
218c48dc052Sriastradh 
219c48dc052Sriastradh 	(*slave_funcs(encoder)->dpms)(encoder, mode);
220c48dc052Sriastradh }
221c48dc052Sriastradh 
222c48dc052Sriastradh void
drm_i2c_encoder_prepare(struct drm_encoder * encoder)223c48dc052Sriastradh drm_i2c_encoder_prepare(struct drm_encoder *encoder)
224c48dc052Sriastradh {
225c48dc052Sriastradh 
226c48dc052Sriastradh 	drm_i2c_encoder_dpms(encoder, DRM_MODE_DPMS_OFF);
227c48dc052Sriastradh }
228c48dc052Sriastradh 
229c48dc052Sriastradh void
drm_i2c_encoder_commit(struct drm_encoder * encoder)230c48dc052Sriastradh drm_i2c_encoder_commit(struct drm_encoder *encoder)
231c48dc052Sriastradh {
232c48dc052Sriastradh 
233c48dc052Sriastradh 	drm_i2c_encoder_dpms(encoder, DRM_MODE_DPMS_ON);
234c48dc052Sriastradh }
235c48dc052Sriastradh 
236c48dc052Sriastradh bool
drm_i2c_encoder_mode_fixup(struct drm_encoder * encoder,const struct drm_display_mode * mode,struct drm_display_mode * adjusted_mode)237c48dc052Sriastradh drm_i2c_encoder_mode_fixup(struct drm_encoder *encoder,
238c48dc052Sriastradh     const struct drm_display_mode *mode,
239c48dc052Sriastradh     struct drm_display_mode *adjusted_mode)
240c48dc052Sriastradh {
241c48dc052Sriastradh 
242c48dc052Sriastradh 	return (*slave_funcs(encoder)->mode_fixup)(encoder, mode,
243c48dc052Sriastradh 	    adjusted_mode);
244c48dc052Sriastradh }
245c48dc052Sriastradh 
246c48dc052Sriastradh void
drm_i2c_encoder_mode_set(struct drm_encoder * encoder,struct drm_display_mode * mode,struct drm_display_mode * adjusted_mode)247c48dc052Sriastradh drm_i2c_encoder_mode_set(struct drm_encoder *encoder,
248c48dc052Sriastradh     struct drm_display_mode *mode, struct drm_display_mode *adjusted_mode)
249c48dc052Sriastradh {
250c48dc052Sriastradh 
251c48dc052Sriastradh 	return (*slave_funcs(encoder)->mode_set)(encoder, mode, adjusted_mode);
252c48dc052Sriastradh }
253c48dc052Sriastradh 
254c48dc052Sriastradh enum drm_connector_status
drm_i2c_encoder_detect(struct drm_encoder * encoder,struct drm_connector * connector)255c48dc052Sriastradh drm_i2c_encoder_detect(struct drm_encoder *encoder,
256c48dc052Sriastradh     struct drm_connector *connector)
257c48dc052Sriastradh {
258c48dc052Sriastradh 
259c48dc052Sriastradh 	return (*slave_funcs(encoder)->detect)(encoder, connector);
260c48dc052Sriastradh }
261c48dc052Sriastradh 
262c48dc052Sriastradh void
drm_i2c_encoder_save(struct drm_encoder * encoder)263c48dc052Sriastradh drm_i2c_encoder_save(struct drm_encoder *encoder)
264c48dc052Sriastradh {
265c48dc052Sriastradh 
266c48dc052Sriastradh 	(*slave_funcs(encoder)->save)(encoder);
267c48dc052Sriastradh }
268c48dc052Sriastradh 
269c48dc052Sriastradh void
drm_i2c_encoder_restore(struct drm_encoder * encoder)270c48dc052Sriastradh drm_i2c_encoder_restore(struct drm_encoder *encoder)
271c48dc052Sriastradh {
272c48dc052Sriastradh 
273c48dc052Sriastradh 	(*slave_funcs(encoder)->restore)(encoder);
274c48dc052Sriastradh }
275