blob: 52c6d534fc211dbb9154fca24461f2c13b2f93b1 (
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
|
/* Copyright 2021 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.
*/
/**
* @file
*
* @brief Common code used by TCPCI partner device emulators
*/
#ifndef __EMUL_TCPCI_PARTNER_COMMON_H
#define __EMUL_TCPCI_PARTNER_COMMON_H
#include <emul.h>
#include "emul/emul_tcpci.h"
#include "ec_commands.h"
#include "usb_pd.h"
/**
* @brief Common code used by TCPCI partner device emulators
* @defgroup tcpci_partner Common code for TCPCI partner device emulators
* @{
*
* Common code for TCPCI partner device emulators allows to send SOP messages
* in generic way using optional delay.
*/
/** Common data for TCPCI partner device emulators */
struct tcpci_partner_data {
/** Work used to send message with delay */
struct k_work_delayable delayed_send;
/** Pointer to connected TCPCI emulator */
const struct emul *tcpci_emul;
/** Queue for delayed messages */
struct k_fifo to_send;
/** Next SOP message id */
int msg_id;
/** Power role (used in message header) */
enum pd_power_role power_role;
/** Data role (used in message header) */
enum pd_data_role data_role;
/** Revision (used in message header) */
enum pd_rev_type rev;
};
/** Structure of message used by TCPCI partner emulator */
struct tcpci_partner_msg {
/** Reserved for k_fifo_* usage */
void *fifo_reserved;
/** TCPCI emulator message */
struct tcpci_emul_msg msg;
/** Time when message should be sent if message is delayed */
uint64_t time;
};
/**
* @brief Initialise common TCPCI partner emulator. Need to be called before
* any other function.
*
* @param data Pointer to USB-C charger emulator
*/
void tcpci_partner_init(struct tcpci_partner_data *data);
/**
* @brief Allocate message
*
* @param size Size of message buffer
*
* @return Pointer to new message on success
* @return NULL on error
*/
struct tcpci_partner_msg *tcpci_partner_alloc_msg(size_t size);
/**
* @brief Free message's memory
*
* @param msg Pointer to message
*/
void tcpci_partner_free_msg(struct tcpci_partner_msg *msg);
/**
* @brief Set header of the message
*
* @param data Pointer to TCPCI partner emulator
* @param msg Pointer to message
* @param type Type of message
* @param cnt Number of data objects
*/
void tcpci_partner_set_header(struct tcpci_partner_data *data,
struct tcpci_partner_msg *msg,
int type, int cnt);
/**
* @brief Send message to TCPCI emulator or schedule message
*
* @param data Pointer to TCPCI partner emulator
* @param msg Pointer to message to send
* @param delay Optional delay
*
* @return 0 on success
* @return -EINVAL on TCPCI emulator add RX message error
*/
int tcpci_partner_send_msg(struct tcpci_partner_data *data,
struct tcpci_partner_msg *msg, uint64_t delay);
/**
* @brief Send control message with optional delay
*
* @param data Pointer to TCPCI partner emulator
* @param type Type of message
* @param delay Optional delay
*
* @return 0 on success
* @return -ENOMEM when there is no free memory for message
* @return -EINVAL on TCPCI emulator add RX message error
*/
int tcpci_partner_send_control_msg(struct tcpci_partner_data *data,
enum pd_ctrl_msg_type type,
uint64_t delay);
/**
* @}
*/
#endif /* __EMUL_TCPCI_PARTNER_COMMON_H */
|
