xref: /linux/include/drm/display/drm_scdc_helper.h (revision 34dc1baba215b826e454b8d19e4f24adbeb7d00d)
1 /*
2  * Copyright (c) 2015 NVIDIA Corporation. All rights reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sub license,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the
12  * next paragraph) shall be included in all copies or substantial portions
13  * of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  */
23 
24 #ifndef DRM_SCDC_HELPER_H
25 #define DRM_SCDC_HELPER_H
26 
27 #include <linux/types.h>
28 
29 #include <drm/display/drm_scdc.h>
30 
31 struct drm_connector;
32 struct i2c_adapter;
33 
34 ssize_t drm_scdc_read(struct i2c_adapter *adapter, u8 offset, void *buffer,
35 		      size_t size);
36 ssize_t drm_scdc_write(struct i2c_adapter *adapter, u8 offset,
37 		       const void *buffer, size_t size);
38 
39 /**
40  * drm_scdc_readb - read a single byte from SCDC
41  * @adapter: I2C adapter
42  * @offset: offset of register to read
43  * @value: return location for the register value
44  *
45  * Reads a single byte from SCDC. This is a convenience wrapper around the
46  * drm_scdc_read() function.
47  *
48  * Returns:
49  * 0 on success or a negative error code on failure.
50  */
51 static inline int drm_scdc_readb(struct i2c_adapter *adapter, u8 offset,
52 				 u8 *value)
53 {
54 	return drm_scdc_read(adapter, offset, value, sizeof(*value));
55 }
56 
57 /**
58  * drm_scdc_writeb - write a single byte to SCDC
59  * @adapter: I2C adapter
60  * @offset: offset of register to read
61  * @value: return location for the register value
62  *
63  * Writes a single byte to SCDC. This is a convenience wrapper around the
64  * drm_scdc_write() function.
65  *
66  * Returns:
67  * 0 on success or a negative error code on failure.
68  */
69 static inline int drm_scdc_writeb(struct i2c_adapter *adapter, u8 offset,
70 				  u8 value)
71 {
72 	return drm_scdc_write(adapter, offset, &value, sizeof(value));
73 }
74 
75 bool drm_scdc_get_scrambling_status(struct drm_connector *connector);
76 
77 bool drm_scdc_set_scrambling(struct drm_connector *connector, bool enable);
78 bool drm_scdc_set_high_tmds_clock_ratio(struct drm_connector *connector, bool set);
79 
80 #endif
81