summaryrefslogtreecommitdiff
path: root/include/drm/display/drm_scdc_helper.h
blob: a3b20adaac7e11b6b15b3499bb16103389db263f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*
 * Copyright (c) 2015 NVIDIA Corporation. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sub license,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef DRM_SCDC_HELPER_H
#define DRM_SCDC_HELPER_H

#include <linux/errno.h>
#include <linux/types.h>

#include <drm/display/drm_scdc.h>

struct drm_connector;
struct i2c_adapter;
struct dentry;

struct drm_scdc_status_flags {
	/* Status Register 0 */
	bool clock_detected;
	bool ch0_locked;
	bool ch1_locked;
	bool ch2_locked;
	bool ln3_locked;
	bool flt_ready;
	bool dsc_fail;

	/* Status Register 1 */
	u8 ln0_training_pattern : 4;
	u8 ln1_training_pattern : 4;

	/* Status Register 2 */
	u8 ln2_training_pattern : 4;
	u8 ln3_training_pattern : 4;
};

enum drm_scdc_frl_rate {
	SCDC_FRL_RATE_OFF = 0,
	SCDC_FRL_RATE_3X3 = 1,
	SCDC_FRL_RATE_6X3 = 2,
	SCDC_FRL_RATE_6X4 = 3,
	SCDC_FRL_RATE_8X4 = 4,
	SCDC_FRL_RATE_10X4 = 5,
	SCDC_FRL_RATE_12X4 = 6,
	SCDC_FRL_RATE_RESV_7 = 7,
	SCDC_FRL_RATE_RESV_8 = 8,
	SCDC_FRL_RATE_RESV_9 = 9,
	SCDC_FRL_RATE_RESV_10 = 10,
	SCDC_FRL_RATE_RESV_11 = 11,
	SCDC_FRL_RATE_RESV_12 = 12,
	SCDC_FRL_RATE_RESV_13 = 13,
	SCDC_FRL_RATE_RESV_14 = 14,
	SCDC_FRL_RATE_RESV_15 = 15
};

/**
 * drm_scdc_num_frl_lanes - get number of lanes for a given FRL rate
 * @rate: one of &enum drm_scdc_frl_rate
 *
 * For a given @rate, return the number of lanes it uses.
 *
 * Returns: %-EINVAL if @rate is not a valid FRL rate, or the number of lanes
 * for a given &enum drm_scdc_frl_rate on success (including %0 for "off")
 */
static inline __pure int drm_scdc_num_frl_lanes(enum drm_scdc_frl_rate rate)
{
	switch (rate) {
	case SCDC_FRL_RATE_OFF:
		return 0;
	case SCDC_FRL_RATE_3X3:
	case SCDC_FRL_RATE_6X3:
		return 3;
	case SCDC_FRL_RATE_6X4:
	case SCDC_FRL_RATE_8X4:
	case SCDC_FRL_RATE_10X4:
	case SCDC_FRL_RATE_12X4:
		return 4;
	default:
		return -EINVAL;
	}
}

struct drm_scdc_state {
	/** @stf: contents of the status flag registers */
	struct drm_scdc_status_flags stf;
	/** @scramling_enabled: true if TMDS scrambling is on */
	bool scrambling_enabled;
	/** @scrambling_detected: true if the sink actually detected scrambling */
	bool scrambling_detected;
	/**
	 * @tmds_bclk_x40: true if TMDS bit period is 1/40th of the TMDS
	 * clock period, false if it's 1/10th of the clock period.
	 */
	bool tmds_bclk_x40;
	/** @rate: FRL rate set by the source */
	enum drm_scdc_frl_rate rate : 4;
	/** @ffe_levels: The FFE levels for @rate set by the source */
	u8 ffe_levels : 4;
	/** @error_count: character error counts for each channel/link */
	u16 error_count[4];
	/** @rs_corrections: number of Reed-Solomon Corrections */
	u16 rs_corrections;
	/** @scdc: raw SCDC data buffer */
	u8 scdc[256];
};

int drm_scdc_read(struct i2c_adapter *adapter, u8 offset, void *buffer,
		  size_t size);
int drm_scdc_write(struct i2c_adapter *adapter, u8 offset, const void *buffer,
		   size_t size);

/**
 * drm_scdc_readb - read a single byte from SCDC
 * @adapter: I2C adapter
 * @offset: offset of register to read
 * @value: return location for the register value
 *
 * Reads a single byte from SCDC. This is a convenience wrapper around the
 * drm_scdc_read() function.
 *
 * Returns:
 * 0 on success or a negative error code on failure.
 */
static inline int drm_scdc_readb(struct i2c_adapter *adapter, u8 offset,
				 u8 *value)
{
	return drm_scdc_read(adapter, offset, value, sizeof(*value));
}

/**
 * drm_scdc_writeb - write a single byte to SCDC
 * @adapter: I2C adapter
 * @offset: offset of register to read
 * @value: return location for the register value
 *
 * Writes a single byte to SCDC. This is a convenience wrapper around the
 * drm_scdc_write() function.
 *
 * Returns:
 * 0 on success or a negative error code on failure.
 */
static inline int drm_scdc_writeb(struct i2c_adapter *adapter, u8 offset,
				  u8 value)
{
	return drm_scdc_write(adapter, offset, &value, sizeof(value));
}

bool drm_scdc_get_scrambling_status(struct drm_connector *connector);

bool drm_scdc_set_scrambling(struct drm_connector *connector, bool enable);
bool drm_scdc_set_high_tmds_clock_ratio(struct drm_connector *connector, bool set);

int drm_scdc_read_state(struct drm_connector *connector,
			struct drm_scdc_state *state);
void drm_scdc_debugfs_init(struct drm_connector *connector, struct dentry *root);

#endif