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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/* Copyright 2019 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* USB Protocol Layer module */
#ifndef __CROS_EC_USB_PRL_H
#define __CROS_EC_USB_PRL_H
#include "common.h"
#include "usb_pd.h"
#include "usb_pd_tcpm.h"
enum prl_tx_state_id {
PRL_TX_PHY_LAYER_RESET,
PRL_TX_WAIT_FOR_MESSAGE_REQUEST,
PRL_TX_LAYER_RESET_FOR_TRANSMIT,
PRL_TX_CONSTRUCT_MESSAGE,
PRL_TX_WAIT_FOR_PHY_RESPONSE,
PRL_TX_MATCH_MESSAGE_ID,
PRL_TX_MESSAGE_SENT,
PRL_TX_CHECK_RETRY_COUNTER,
PRL_TX_TRANSMISSION_ERROR,
PRL_TX_DISCARD_MESSAGE,
PRL_TX_SRC_SINK_TX,
PRL_TX_SRC_SOURCE_TX,
PRL_TX_SRC_PENDING,
PRL_TX_SNK_START_OF_AMS,
PRL_TX_SNK_PENDING,
};
enum prl_hr_state_id {
PRL_HR_WAIT_FOR_REQUEST,
PRL_HR_RESET_LAYER,
PRL_HR_INDICATE_HARD_RESET,
PRL_HR_WAIT_FOR_PHY_HARD_RESET_COMPLETE,
PRL_HR_PHY_HARD_RESET_REQUESTED,
PRL_HR_WAIT_FOR_PE_HARD_RESET_COMPLETE,
PRL_HR_PE_HARD_RESET_COMPLETE,
};
enum rch_state_id {
RCH_WAIT_FOR_MESSAGE_FROM_PROTOCOL_LAYER,
RCH_PASS_UP_MESSAGE,
RCH_PROCESSING_EXTENDED_MESSAGE,
RCH_REQUESTING_CHUNK,
RCH_WAITING_CHUNK,
RCH_REPORT_ERROR,
};
enum tch_state_id {
TCH_WAIT_FOR_MESSAGE_REQUEST_FROM_PE,
TCH_PASS_DOWN_MESSAGE,
TCH_WAIT_FOR_TRANSMISSION_COMPLETE,
TCH_MESSAGE_SENT,
TCH_PREPARE_TO_SEND_CHUNKED_MESSAGE,
TCH_CONSTRUCT_CHUNKED_MESSAGE,
TCH_SENDING_CHUNKED_MESSAGE,
TCH_WAIT_CHUNK_REQUEST,
TCH_MESSAGE_RECEIVED,
TCH_REPORT_ERROR,
};
/*
* Number of times the Protocol Layer will try to transmit a message
* before giving up and signaling an error
*/
#define N_RETRY_COUNT 2
/**
* Initialize the Protocol Layer State Machine
*
* @param port USB-C port number
*/
void prl_init(int port);
/**
* Resets the Protocol Layer State Machine
*
* @param port USB-C port number
*/
void prl_reset(int port);
/**
* Get Chunked Rx State Machine state id
*
* @param port USB-C port number
* @return id
*/
enum rch_state_id get_rch_state_id(int port);
/**
* Get Chunked Tx State Machine state id
*
* @param port USB-C port number
* @return id
*/
enum tch_state_id get_tch_state_id(int port);
/**
* Get Message Transmission State Machine state id
*
* @param port USB-C port number
* @return id
*/
enum prl_tx_state_id get_prl_tx_state_id(int port);
/**
* Get Hard Reset State Machine state id
*
* @param port USB-C port number
* @return id
*/
enum prl_hr_state_id get_prl_hr_state_id(int port);
/**
* Returns the state of the PRL state machine
* @return SM_INIT for initializing
* SM_RUN for running
* SM_PAUSED for paused
*/
enum sm_local_state prl_get_local_state(int port);
/**
* Runs the Protocol Layer State Machine
*
* @param port USB-C port number
* @param evt system event, ie: PD_EVENT_RX
* @param en 0 to disable the machine, 1 to enable the machine
*/
void protocol_layer(int port, int evt, int en);
/**
* Set the PD revision
*
* @param port USB-C port number
* @param rev revision
*/
void prl_set_rev(int port, enum pd_rev_type rev);
/**
* Get the PD revision
*
* @param port USB-C port number
* @return pd rev
*/
enum pd_rev_type prl_get_rev(int port);
/**
* Sends a PD control message
*
* @param port USB-C port number
* @param type Transmit type
* @param msg Control message type
* @return 0 on EC_SUCCESS, else EC_ERROR_BUSY
*/
void prl_send_ctrl_msg(int port, enum tcpm_transmit_type type,
enum pd_ctrl_msg_type msg);
/**
* Sends a PD data message
*
* @param port USB-C port number
* @param type Transmit type
* @param msg Data message type
* @return 0 on EC_SUCCESS, else EC_ERROR_BUSY
*/
void prl_send_data_msg(int port, enum tcpm_transmit_type type,
enum pd_data_msg_type msg);
/**
* Sends a PD extended data message
*
* @param port USB-C port number
* @param type Transmit type
* @param msg Extended data message type
* @return 0 on EC_SUCCESS, else EC_ERROR_BUSY
*/
void prl_send_ext_data_msg(int port, enum tcpm_transmit_type type,
enum pd_ext_msg_type msg);
/**
* Informs the Protocol Layer that a hard reset has completed
*
* @param port USB-C port number
*/
void prl_hard_reset_complete(int port);
/**
* Policy Engine calls this function to execute a hard reset.
*
* @param port USB-C port number
*/
void prl_execute_hard_reset(int port);
/**
* Informs the Protocol Layer to start an Atomic Message Sequence
*
* @param port USB-C port number
*/
void prl_start_ams(int port);
/**
* Informs the Protocol Layer to end an Atomic Message Sequence
*
* @param port USB-C port number
*/
void prl_end_ams(int port);
#endif /* __CROS_EC_USB_PRL_H */
|
