Skip to content

Commit 467399d

Browse files
lumaggregkh
lumag
authored and
gregkh
committed
usb: typec: ucsi: split read operation
The read operation is only used to read fixed data at fixed offsets (UCSI_VERSION, UCSI_CCI, UCSI_MESSAGE_IN). In some cases drivers apply offset-specific overrides. Split the read() operation into three operations, read_version(), read_cci(), read_message_in(). Tested-by: Heikki Krogerus <heikki.krogerus@linux.intel.com> Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com> Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org> Link: https://lore.kernel.org/r/20240627-ucsi-rework-interface-v4-3-289ddc6874c7@linaro.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent 13f2ec3 commit 467399d

7 files changed

Lines changed: 169 additions & 72 deletions

File tree

‎drivers/usb/typec/ucsi/ucsi.c‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ static int ucsi_read_message_in(struct ucsi *ucsi, void *buf,
4646
if (ucsi->version <= UCSI_VERSION_1_2)
4747
buf_size = clamp(buf_size, 0, 16);
4848

49-
return ucsi->ops->read(ucsi, UCSI_MESSAGE_IN, buf, buf_size);
49+
return ucsi->ops->read_message_in(ucsi, buf, buf_size);
5050
}
5151

5252
static int ucsi_acknowledge(struct ucsi *ucsi, bool conn_ack)
@@ -159,7 +159,7 @@ static int ucsi_exec_command(struct ucsi *ucsi, u64 cmd)
159159
if (ret)
160160
return ret;
161161

162-
ret = ucsi->ops->read(ucsi, UCSI_CCI, &cci, sizeof(cci));
162+
ret = ucsi->ops->read_cci(ucsi, &cci);
163163
if (ret)
164164
return ret;
165165

@@ -1338,7 +1338,7 @@ static int ucsi_reset_ppm(struct ucsi *ucsi)
13381338

13391339
mutex_lock(&ucsi->ppm_lock);
13401340

1341-
ret = ucsi->ops->read(ucsi, UCSI_CCI, &cci, sizeof(cci));
1341+
ret = ucsi->ops->read_cci(ucsi, &cci);
13421342
if (ret < 0)
13431343
goto out;
13441344

@@ -1356,8 +1356,7 @@ static int ucsi_reset_ppm(struct ucsi *ucsi)
13561356

13571357
tmo = jiffies + msecs_to_jiffies(UCSI_TIMEOUT_MS);
13581358
do {
1359-
ret = ucsi->ops->read(ucsi, UCSI_CCI,
1360-
&cci, sizeof(cci));
1359+
ret = ucsi->ops->read_cci(ucsi, &cci);
13611360
if (ret < 0)
13621361
goto out;
13631362
if (cci & UCSI_CCI_COMMAND_COMPLETE)
@@ -1386,7 +1385,7 @@ static int ucsi_reset_ppm(struct ucsi *ucsi)
13861385
/* Give the PPM time to process a reset before reading CCI */
13871386
msleep(20);
13881387

1389-
ret = ucsi->ops->read(ucsi, UCSI_CCI, &cci, sizeof(cci));
1388+
ret = ucsi->ops->read_cci(ucsi, &cci);
13901389
if (ret)
13911390
goto out;
13921391

@@ -1806,7 +1805,7 @@ static int ucsi_init(struct ucsi *ucsi)
18061805
ucsi->ntfy = ntfy;
18071806

18081807
mutex_lock(&ucsi->ppm_lock);
1809-
ret = ucsi->ops->read(ucsi, UCSI_CCI, &cci, sizeof(cci));
1808+
ret = ucsi->ops->read_cci(ucsi, &cci);
18101809
mutex_unlock(&ucsi->ppm_lock);
18111810
if (ret)
18121811
return ret;
@@ -1920,7 +1919,9 @@ struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops)
19201919
{
19211920
struct ucsi *ucsi;
19221921

1923-
if (!ops || !ops->read || !ops->sync_control || !ops->async_control)
1922+
if (!ops ||
1923+
!ops->read_version || !ops->read_cci || !ops->read_message_in ||
1924+
!ops->sync_control || !ops->async_control)
19241925
return ERR_PTR(-EINVAL);
19251926

19261927
ucsi = kzalloc(sizeof(*ucsi), GFP_KERNEL);
@@ -1956,8 +1957,7 @@ int ucsi_register(struct ucsi *ucsi)
19561957
{
19571958
int ret;
19581959

1959-
ret = ucsi->ops->read(ucsi, UCSI_VERSION, &ucsi->version,
1960-
sizeof(ucsi->version));
1960+
ret = ucsi->ops->read_version(ucsi, &ucsi->version);
19611961
if (ret)
19621962
return ret;
19631963

‎drivers/usb/typec/ucsi/ucsi.h‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ struct dentry;
5656

5757
/**
5858
* struct ucsi_operations - UCSI I/O operations
59-
* @read: Read operation
59+
* @read_version: Read implemented UCSI version
60+
* @read_cci: Read CCI register
61+
* @read_message_in: Read message data from UCSI
6062
* @sync_control: Blocking control operation
6163
* @async_control: Non-blocking control operation
6264
* @update_altmodes: Squashes duplicate DP altmodes
@@ -68,8 +70,9 @@ struct dentry;
6870
* return immediately after sending the data to the PPM.
6971
*/
7072
struct ucsi_operations {
71-
int (*read)(struct ucsi *ucsi, unsigned int offset,
72-
void *val, size_t val_len);
73+
int (*read_version)(struct ucsi *ucsi, u16 *version);
74+
int (*read_cci)(struct ucsi *ucsi, u32 *cci);
75+
int (*read_message_in)(struct ucsi *ucsi, void *val, size_t val_len);
7376
int (*sync_control)(struct ucsi *ucsi, u64 command);
7477
int (*async_control)(struct ucsi *ucsi, u64 command);
7578
bool (*update_altmodes)(struct ucsi *ucsi, struct ucsi_altmode *orig,

‎drivers/usb/typec/ucsi/ucsi_acpi.c‎

Lines changed: 57 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ static int ucsi_acpi_dsm(struct ucsi_acpi *ua, int func)
4646
return 0;
4747
}
4848

49-
static int ucsi_acpi_read(struct ucsi *ucsi, unsigned int offset,
50-
void *val, size_t val_len)
49+
static int ucsi_acpi_read_version(struct ucsi *ucsi, u16 *version)
5150
{
5251
struct ucsi_acpi *ua = ucsi_get_drvdata(ucsi);
5352
int ret;
@@ -56,7 +55,35 @@ static int ucsi_acpi_read(struct ucsi *ucsi, unsigned int offset,
5655
if (ret)
5756
return ret;
5857

59-
memcpy(val, ua->base + offset, val_len);
58+
memcpy(version, ua->base + UCSI_VERSION, sizeof(*version));
59+
60+
return 0;
61+
}
62+
63+
static int ucsi_acpi_read_cci(struct ucsi *ucsi, u32 *cci)
64+
{
65+
struct ucsi_acpi *ua = ucsi_get_drvdata(ucsi);
66+
int ret;
67+
68+
ret = ucsi_acpi_dsm(ua, UCSI_DSM_FUNC_READ);
69+
if (ret)
70+
return ret;
71+
72+
memcpy(cci, ua->base + UCSI_CCI, sizeof(*cci));
73+
74+
return 0;
75+
}
76+
77+
static int ucsi_acpi_read_message_in(struct ucsi *ucsi, void *val, size_t val_len)
78+
{
79+
struct ucsi_acpi *ua = ucsi_get_drvdata(ucsi);
80+
int ret;
81+
82+
ret = ucsi_acpi_dsm(ua, UCSI_DSM_FUNC_READ);
83+
if (ret)
84+
return ret;
85+
86+
memcpy(val, ua->base + UCSI_MESSAGE_IN, val_len);
6087

6188
return 0;
6289
}
@@ -99,50 +126,63 @@ static int ucsi_acpi_sync_control(struct ucsi *ucsi, u64 command)
99126
}
100127

101128
static const struct ucsi_operations ucsi_acpi_ops = {
102-
.read = ucsi_acpi_read,
129+
.read_version = ucsi_acpi_read_version,
130+
.read_cci = ucsi_acpi_read_cci,
131+
.read_message_in = ucsi_acpi_read_message_in,
103132
.sync_control = ucsi_acpi_sync_control,
104133
.async_control = ucsi_acpi_async_control
105134
};
106135

107136
static int
108-
ucsi_zenbook_read(struct ucsi *ucsi, unsigned int offset, void *val, size_t val_len)
137+
ucsi_zenbook_read_cci(struct ucsi *ucsi, u32 *cci)
109138
{
110139
struct ucsi_acpi *ua = ucsi_get_drvdata(ucsi);
111140
int ret;
112141

113-
if (offset == UCSI_VERSION || UCSI_COMMAND(ua->cmd) == UCSI_PPM_RESET) {
142+
if (UCSI_COMMAND(ua->cmd) == UCSI_PPM_RESET) {
114143
ret = ucsi_acpi_dsm(ua, UCSI_DSM_FUNC_READ);
115144
if (ret)
116145
return ret;
117146
}
118147

119-
memcpy(val, ua->base + offset, val_len);
148+
memcpy(cci, ua->base + UCSI_CCI, sizeof(*cci));
149+
150+
return 0;
151+
}
152+
153+
static int
154+
ucsi_zenbook_read_message_in(struct ucsi *ucsi, void *val, size_t val_len)
155+
{
156+
struct ucsi_acpi *ua = ucsi_get_drvdata(ucsi);
157+
158+
/* UCSI_MESSAGE_IN is never read for PPM_RESET, return stored data */
159+
memcpy(val, ua->base + UCSI_MESSAGE_IN, val_len);
120160

121161
return 0;
122162
}
123163

124164
static const struct ucsi_operations ucsi_zenbook_ops = {
125-
.read = ucsi_zenbook_read,
165+
.read_version = ucsi_acpi_read_version,
166+
.read_cci = ucsi_zenbook_read_cci,
167+
.read_message_in = ucsi_zenbook_read_message_in,
126168
.sync_control = ucsi_acpi_sync_control,
127169
.async_control = ucsi_acpi_async_control
128170
};
129171

130-
static int ucsi_gram_read(struct ucsi *ucsi, unsigned int offset,
131-
void *val, size_t val_len)
172+
static int ucsi_gram_read_message_in(struct ucsi *ucsi, void *val, size_t val_len)
132173
{
133174
u16 bogus_change = UCSI_CONSTAT_POWER_LEVEL_CHANGE |
134175
UCSI_CONSTAT_PDOS_CHANGE;
135176
struct ucsi_acpi *ua = ucsi_get_drvdata(ucsi);
136177
struct ucsi_connector_status *status;
137178
int ret;
138179

139-
ret = ucsi_acpi_read(ucsi, offset, val, val_len);
180+
ret = ucsi_acpi_read_message_in(ucsi, val, val_len);
140181
if (ret < 0)
141182
return ret;
142183

143184
if (UCSI_COMMAND(ua->cmd) == UCSI_GET_CONNECTOR_STATUS &&
144-
test_bit(UCSI_ACPI_CHECK_BOGUS_EVENT, &ua->flags) &&
145-
offset == UCSI_MESSAGE_IN) {
185+
test_bit(UCSI_ACPI_CHECK_BOGUS_EVENT, &ua->flags)) {
146186
status = (struct ucsi_connector_status *)val;
147187

148188
/* Clear the bogus change */
@@ -173,7 +213,9 @@ static int ucsi_gram_sync_control(struct ucsi *ucsi, u64 command)
173213
}
174214

175215
static const struct ucsi_operations ucsi_gram_ops = {
176-
.read = ucsi_gram_read,
216+
.read_version = ucsi_acpi_read_version,
217+
.read_cci = ucsi_acpi_read_cci,
218+
.read_message_in = ucsi_gram_read_message_in,
177219
.sync_control = ucsi_gram_sync_control,
178220
.async_control = ucsi_acpi_async_control
179221
};
@@ -203,7 +245,7 @@ static void ucsi_acpi_notify(acpi_handle handle, u32 event, void *data)
203245
u32 cci;
204246
int ret;
205247

206-
ret = ua->ucsi->ops->read(ua->ucsi, UCSI_CCI, &cci, sizeof(cci));
248+
ret = ua->ucsi->ops->read_cci(ua->ucsi, &cci);
207249
if (ret)
208250
return;
209251

‎drivers/usb/typec/ucsi/ucsi_ccg.c‎

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -556,32 +556,34 @@ static void ucsi_ccg_nvidia_altmode(struct ucsi_ccg *uc,
556556
}
557557
}
558558

559-
static int ucsi_ccg_read(struct ucsi *ucsi, unsigned int offset,
560-
void *val, size_t val_len)
559+
static int ucsi_ccg_read_version(struct ucsi *ucsi, u16 *version)
561560
{
562561
struct ucsi_ccg *uc = ucsi_get_drvdata(ucsi);
563-
u16 reg = CCGX_RAB_UCSI_DATA_BLOCK(offset);
564-
struct ucsi_capability *cap;
565-
struct ucsi_altmode *alt;
566-
int ret = 0;
562+
u16 reg = CCGX_RAB_UCSI_DATA_BLOCK(UCSI_VERSION);
567563

568-
if (offset == UCSI_CCI) {
569-
spin_lock(&uc->op_lock);
570-
memcpy(val, &(uc->op_data).cci, val_len);
571-
spin_unlock(&uc->op_lock);
572-
} else if (offset == UCSI_MESSAGE_IN) {
573-
spin_lock(&uc->op_lock);
574-
memcpy(val, &(uc->op_data).message_in, val_len);
575-
spin_unlock(&uc->op_lock);
576-
} else {
577-
ret = ccg_read(uc, reg, val, val_len);
578-
}
564+
return ccg_read(uc, reg, (u8 *)version, sizeof(*version));
565+
}
579566

580-
if (ret)
581-
return ret;
567+
static int ucsi_ccg_read_cci(struct ucsi *ucsi, u32 *cci)
568+
{
569+
struct ucsi_ccg *uc = ucsi_get_drvdata(ucsi);
582570

583-
if (offset != UCSI_MESSAGE_IN)
584-
return ret;
571+
spin_lock(&uc->op_lock);
572+
*cci = uc->op_data.cci;
573+
spin_unlock(&uc->op_lock);
574+
575+
return 0;
576+
}
577+
578+
static int ucsi_ccg_read_message_in(struct ucsi *ucsi, void *val, size_t val_len)
579+
{
580+
struct ucsi_ccg *uc = ucsi_get_drvdata(ucsi);
581+
struct ucsi_capability *cap;
582+
struct ucsi_altmode *alt;
583+
584+
spin_lock(&uc->op_lock);
585+
memcpy(val, uc->op_data.message_in, val_len);
586+
spin_unlock(&uc->op_lock);
585587

586588
switch (UCSI_COMMAND(uc->last_cmd_sent)) {
587589
case UCSI_GET_CURRENT_CAM:
@@ -607,7 +609,7 @@ static int ucsi_ccg_read(struct ucsi *ucsi, unsigned int offset,
607609
}
608610
uc->last_cmd_sent = 0;
609611

610-
return ret;
612+
return 0;
611613
}
612614

613615
static int ucsi_ccg_async_control(struct ucsi *ucsi, u64 command)
@@ -663,7 +665,9 @@ static int ucsi_ccg_sync_control(struct ucsi *ucsi, u64 command)
663665
}
664666

665667
static const struct ucsi_operations ucsi_ccg_ops = {
666-
.read = ucsi_ccg_read,
668+
.read_version = ucsi_ccg_read_version,
669+
.read_cci = ucsi_ccg_read_cci,
670+
.read_message_in = ucsi_ccg_read_message_in,
667671
.sync_control = ucsi_ccg_sync_control,
668672
.async_control = ucsi_ccg_async_control,
669673
.update_altmodes = ucsi_ccg_update_altmodes

‎drivers/usb/typec/ucsi/ucsi_glink.c‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,21 @@ static int pmic_glink_ucsi_read(struct ucsi *__ucsi, unsigned int offset,
114114
return ret;
115115
}
116116

117+
static int pmic_glink_ucsi_read_version(struct ucsi *ucsi, u16 *version)
118+
{
119+
return pmic_glink_ucsi_read(ucsi, UCSI_VERSION, version, sizeof(*version));
120+
}
121+
122+
static int pmic_glink_ucsi_read_cci(struct ucsi *ucsi, u32 *cci)
123+
{
124+
return pmic_glink_ucsi_read(ucsi, UCSI_CCI, cci, sizeof(*cci));
125+
}
126+
127+
static int pmic_glink_ucsi_read_message_in(struct ucsi *ucsi, void *val, size_t val_len)
128+
{
129+
return pmic_glink_ucsi_read(ucsi, UCSI_MESSAGE_IN, val, val_len);
130+
}
131+
117132
static int pmic_glink_ucsi_locked_write(struct pmic_glink_ucsi *ucsi, unsigned int offset,
118133
const void *val, size_t val_len)
119134
{
@@ -214,7 +229,9 @@ static void pmic_glink_ucsi_connector_status(struct ucsi_connector *con)
214229
}
215230

216231
static const struct ucsi_operations pmic_glink_ucsi_ops = {
217-
.read = pmic_glink_ucsi_read,
232+
.read_version = pmic_glink_ucsi_read_version,
233+
.read_cci = pmic_glink_ucsi_read_cci,
234+
.read_message_in = pmic_glink_ucsi_read_message_in,
218235
.sync_control = pmic_glink_ucsi_sync_control,
219236
.async_control = pmic_glink_ucsi_async_control,
220237
.update_connector = pmic_glink_ucsi_update_connector,

‎drivers/usb/typec/ucsi/ucsi_stm32g0.c‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,21 @@ static int ucsi_stm32g0_read(struct ucsi *ucsi, unsigned int offset, void *val,
359359
return 0;
360360
}
361361

362+
static int ucsi_stm32g0_read_version(struct ucsi *ucsi, u16 *version)
363+
{
364+
return ucsi_stm32g0_read(ucsi, UCSI_VERSION, version, sizeof(*version));
365+
}
366+
367+
static int ucsi_stm32g0_read_cci(struct ucsi *ucsi, u32 *cci)
368+
{
369+
return ucsi_stm32g0_read(ucsi, UCSI_CCI, cci, sizeof(*cci));
370+
}
371+
372+
static int ucsi_stm32g0_read_message_in(struct ucsi *ucsi, void *val, size_t len)
373+
{
374+
return ucsi_stm32g0_read(ucsi, UCSI_MESSAGE_IN, val, len);
375+
}
376+
362377
static int ucsi_stm32g0_async_control(struct ucsi *ucsi, u64 command)
363378
{
364379
struct ucsi_stm32g0 *g0 = ucsi_get_drvdata(ucsi);
@@ -446,7 +461,9 @@ static irqreturn_t ucsi_stm32g0_irq_handler(int irq, void *data)
446461
}
447462

448463
static const struct ucsi_operations ucsi_stm32g0_ops = {
449-
.read = ucsi_stm32g0_read,
464+
.read_version = ucsi_stm32g0_read_version,
465+
.read_cci = ucsi_stm32g0_read_cci,
466+
.read_message_in = ucsi_stm32g0_read_message_in,
450467
.sync_control = ucsi_stm32g0_sync_control,
451468
.async_control = ucsi_stm32g0_async_control,
452469
};

0 commit comments

Comments
 (0)