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
|
/*
* 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.
*/
#ifndef __CROS_EC_IOEXPANDER_H
#define __CROS_EC_IOEXPANDER_H
/* IO expander signal definition structure */
struct ioex_info {
/* Signal name */
const char *name;
/* IO expander port number */
uint16_t ioex;
/* IO port number in IO expander */
uint16_t port;
/* Bitmask on that port (1 << N) */
uint32_t mask;
/* Flags - the same as the GPIO flags */
uint32_t flags;
};
/* Signal information from board.c. Must match order from enum ioex_signal. */
extern const struct ioex_info ioex_list[];
struct ioexpander_drv {
/* Initialize IO expander chip/driver */
int (*init)(int ioex);
/* Get the current level of the IOEX pin */
int (*get_level)(int ioex, int port, int mask, int *val);
/* Set the level of the IOEX pin */
int (*set_level)(int ioex, int port, int mask, int val);
/* Get flags for the IOEX pin */
int (*get_flags_by_mask)(int ioex, int port, int mask, int *flags);
/* Set flags for the IOEX pin */
int (*set_flags_by_mask)(int ioex, int port, int mask, int flags);
};
struct ioexpander_config_t {
/* Physical I2C port connects to the IO expander chip. */
int i2c_host_port;
/* I2C slave address */
int i2c_slave_addr;
/*
* The extra variable used to store information which may be required
* by the IO expander chip.
*/
int chip_info;
/*
* Pointer to the specific IO expander chip's ops defined in
* the struct ioexpander_drv.
*/
const struct ioexpander_drv *drv;
};
extern struct ioexpander_config_t ioex_config[];
/*
* Get flags for the IOEX pin by mask
*
* @param ioex IO expander chip's port number
* @param port IO port in the IO expander chip
* @param mask Bitmask of the pin on the port above
* @param flags Pointer to the keep the flags read
* @return EC_SUCCESS if successful, non-zero if error.
*/
int ioex_get_flags_by_mask(int ioex, int port, int mask, int *flags);
/*
* Set flags for the IOEX pin by mask
*
* @param ioex IO expander chip's port number
* @param port IO port in the IO expander chip
* @param mask Bitmask of the pin on the port above
* @param flags flags to set
* @return EC_SUCCESS if successful, non-zero if error.
*/
int ioex_set_flags_by_mask(int ioex, int port, int mask, int flags);
/*
* Get flags for the IOEX signal
*
* @param signal IOEX signal to get flags for
* @param flags Pointer to the keep the flags read
* @return EC_SUCCESS if successful, non-zero if error.
*/
int ioex_get_flags(enum ioex_signal signal, int *flags);
/*
* Set flags for the IOEX signal
*
* @param signal IOEX signal to set flags for
* @param flags New flags for the IOEX signal
* @return EC_SUCCESS if successful, non-zero if error.
*/
int ioex_set_flags(enum ioex_signal signal, int flags);
/*
* Get the current level of the IOEX signal
*
* @param signal IOEX signal to get the level
* @param val Pointer to the keep the level read
* @return EC_SUCCESS if successful, non-zero if error.
*/
int ioex_get_level(enum ioex_signal signal, int *val);
/*
* Set the level of the IOEX signal
*
* @param signal IOEX signal to set the level
* @param value New level for the IOEX signal
* @return EC_SUCCESS if successful, non-zero if error.
*/
int ioex_set_level(enum ioex_signal signal, int value);
/*
* Initialize IO expander chip/driver
*
* @param ioex IO expander chip's port number
* @return EC_SUCCESS if successful, non-zero if error.
*/
int ioex_init(int ioex);
/*
* Get the name for the IOEX signal
*
* @param signal IOEX signal to get the name
* @returns name of the given IOEX signal
*/
const char *ioex_get_name(enum ioex_signal signal);
#endif /* __CROS_EC_IOEXPANDER_H */
|
