d0cf7b85192ce4431bb4c8c57e2d7501df83ac43

Author
Ryan <fauxpark@gmail.com>
Committer
GitHub <noreply@github.com>
Date

Message

Update GPIO expander API naming (#23375)

Diff

  1diff --git a/drivers/gpio/mcp23018.c b/drivers/gpio/mcp23018.c
  2index 3eca4f9d34c1f08446230b048a2402d8a13944ed..0791db08ddabe433f26239f613db79d045299600 100644
  3--- a/drivers/gpio/mcp23018.c
  4+++ b/drivers/gpio/mcp23018.c
  5@@ -74,20 +74,20 @@ bool mcp23018_set_output_all(uint8_t slave_addr, uint8_t confA, uint8_t confB) {
  6     return true;
  7 }
  8 
  9-bool mcp23018_readPins(uint8_t slave_addr, mcp23018_port_t port, uint8_t* out) {
 10+bool mcp23018_read_pins(uint8_t slave_addr, mcp23018_port_t port, uint8_t* out) {
 11     uint8_t addr = SLAVE_TO_ADDR(slave_addr);
 12     uint8_t cmd  = port ? CMD_GPIOB : CMD_GPIOA;
 13 
 14     i2c_status_t ret = i2c_read_register(addr, cmd, out, sizeof(uint8_t), TIMEOUT);
 15     if (ret != I2C_STATUS_SUCCESS) {
 16-        dprintf("mcp23018_readPins::FAILED::%u\n", ret);
 17+        dprintf("mcp23018_read_pins::FAILED::%u\n", ret);
 18         return false;
 19     }
 20 
 21     return true;
 22 }
 23 
 24-bool mcp23018_readPins_all(uint8_t slave_addr, uint16_t* out) {
 25+bool mcp23018_read_pins_all(uint8_t slave_addr, uint16_t* out) {
 26     uint8_t addr = SLAVE_TO_ADDR(slave_addr);
 27 
 28     typedef union {
 29@@ -99,7 +99,7 @@ bool mcp23018_readPins_all(uint8_t slave_addr, uint16_t* out) {
 30 
 31     i2c_status_t ret = i2c_read_register(addr, CMD_GPIOA, &data.u8[0], sizeof(data), TIMEOUT);
 32     if (ret != I2C_STATUS_SUCCESS) {
 33-        dprintf("mcp23018_readPins::FAILED::%u\n", ret);
 34+        dprintf("mcp23018_read_pins_all::FAILED::%u\n", ret);
 35         return false;
 36     }
 37 
 38diff --git a/drivers/gpio/mcp23018.h b/drivers/gpio/mcp23018.h
 39index e7c2730dd155b475928fd6a242e2003f14f173a5..98c818fb8d54c72366990edcb540414368075585 100644
 40--- a/drivers/gpio/mcp23018.h
 41+++ b/drivers/gpio/mcp23018.h
 42@@ -55,11 +55,16 @@ bool mcp23018_set_output_all(uint8_t slave_addr, uint8_t confA, uint8_t confB);
 43 /**
 44  * Read state of a given port
 45  */
 46-bool mcp23018_readPins(uint8_t slave_addr, mcp23018_port_t port, uint8_t* ret);
 47+bool mcp23018_read_pins(uint8_t slave_addr, mcp23018_port_t port, uint8_t* ret);
 48 
 49 /**
 50  * Read state of both ports sequentially
 51  *
 52  *  - slightly faster than multiple readPins
 53  */
 54-bool mcp23018_readPins_all(uint8_t slave_addr, uint16_t* ret);
 55+bool mcp23018_read_pins_all(uint8_t slave_addr, uint16_t* ret);
 56+
 57+// DEPRECATED - DO NOT USE
 58+
 59+#define mcp23018_readPins mcp23018_read_pins
 60+#define mcp23018_readPins_all mcp23018_read_pins_all
 61diff --git a/drivers/gpio/pca9505.c b/drivers/gpio/pca9505.c
 62index 5617a14a8b13c1e1d948f4ba7df704ec5fd7bd84..d1adc61a23718b92c789714f7af2fc312171c59a 100644
 63--- a/drivers/gpio/pca9505.c
 64+++ b/drivers/gpio/pca9505.c
 65@@ -133,7 +133,7 @@ bool pca9505_set_output(uint8_t slave_addr, pca9505_port_t port, uint8_t conf) {
 66     return true;
 67 }
 68 
 69-bool pca9505_readPins(uint8_t slave_addr, pca9505_port_t port, uint8_t* out) {
 70+bool pca9505_read_pins(uint8_t slave_addr, pca9505_port_t port, uint8_t* out) {
 71     uint8_t addr = SLAVE_TO_ADDR(slave_addr);
 72     uint8_t cmd  = 0;
 73     switch (port) {
 74@@ -156,7 +156,7 @@ bool pca9505_readPins(uint8_t slave_addr, pca9505_port_t port, uint8_t* out) {
 75 
 76     i2c_status_t ret = i2c_read_register(addr, cmd, out, sizeof(uint8_t), TIMEOUT);
 77     if (ret != I2C_STATUS_SUCCESS) {
 78-        print("pca9505_readPins::FAILED\n");
 79+        print("pca9505_read_pins::FAILED\n");
 80         return false;
 81     }
 82 
 83diff --git a/drivers/gpio/pca9505.h b/drivers/gpio/pca9505.h
 84index 732ddb88ead734671bb2f1a3ea5323ee280ab319..0cec8610d94a107b8ef2b45c6d8e9cf91fd61e2b 100644
 85--- a/drivers/gpio/pca9505.h
 86+++ b/drivers/gpio/pca9505.h
 87@@ -64,4 +64,8 @@ bool pca9505_set_output(uint8_t slave_addr, pca9505_port_t port, uint8_t conf);
 88 /**
 89  * Read state of a given port
 90  */
 91-bool pca9505_readPins(uint8_t slave_addr, pca9505_port_t port, uint8_t* ret);
 92+bool pca9505_read_pins(uint8_t slave_addr, pca9505_port_t port, uint8_t* ret);
 93+
 94+// DEPRECATED - DO NOT USE
 95+
 96+#define pca9505_readPins pca9505_read_pins
 97diff --git a/drivers/gpio/pca9555.c b/drivers/gpio/pca9555.c
 98index 0fc30099ac3a0bae6565740dc03bd518ac2122ab..28b74e1a7008c78e40eebf6b6329a6101708985c 100644
 99--- a/drivers/gpio/pca9555.c
100+++ b/drivers/gpio/pca9555.c
101@@ -70,20 +70,20 @@ bool pca9555_set_output_all(uint8_t slave_addr, uint8_t confA, uint8_t confB) {
102     return true;
103 }
104 
105-bool pca9555_readPins(uint8_t slave_addr, pca9555_port_t port, uint8_t* out) {
106+bool pca9555_read_pins(uint8_t slave_addr, pca9555_port_t port, uint8_t* out) {
107     uint8_t addr = SLAVE_TO_ADDR(slave_addr);
108     uint8_t cmd  = port ? CMD_INPUT_1 : CMD_INPUT_0;
109 
110     i2c_status_t ret = i2c_read_register(addr, cmd, out, sizeof(uint8_t), TIMEOUT);
111     if (ret != I2C_STATUS_SUCCESS) {
112-        print("pca9555_readPins::FAILED\n");
113+        print("pca9555_read_pins::FAILED\n");
114         return false;
115     }
116 
117     return true;
118 }
119 
120-bool pca9555_readPins_all(uint8_t slave_addr, uint16_t* out) {
121+bool pca9555_read_pins_all(uint8_t slave_addr, uint16_t* out) {
122     uint8_t addr = SLAVE_TO_ADDR(slave_addr);
123 
124     typedef union {
125@@ -95,7 +95,7 @@ bool pca9555_readPins_all(uint8_t slave_addr, uint16_t* out) {
126 
127     i2c_status_t ret = i2c_read_register(addr, CMD_INPUT_0, &data.u8[0], sizeof(data), TIMEOUT);
128     if (ret != I2C_STATUS_SUCCESS) {
129-        print("pca9555_readPins_all::FAILED\n");
130+        print("pca9555_read_pins_all::FAILED\n");
131         return false;
132     }
133 
134diff --git a/drivers/gpio/pca9555.h b/drivers/gpio/pca9555.h
135index 6362ab68aebaf7c177e58c1e23c15e673dade0b9..f089022e84ff22c7f6191c137d49a32547a1d2b5 100644
136--- a/drivers/gpio/pca9555.h
137+++ b/drivers/gpio/pca9555.h
138@@ -78,11 +78,16 @@ bool pca9555_set_output_all(uint8_t slave_addr, uint8_t confA, uint8_t confB);
139 /**
140  * Read state of a given port
141  */
142-bool pca9555_readPins(uint8_t slave_addr, pca9555_port_t port, uint8_t* ret);
143+bool pca9555_read_pins(uint8_t slave_addr, pca9555_port_t port, uint8_t* ret);
144 
145 /**
146  * Read state of both ports sequentially
147  *
148  *  - slightly faster than multiple readPins
149  */
150-bool pca9555_readPins_all(uint8_t slave_addr, uint16_t* ret);
151+bool pca9555_read_pins_all(uint8_t slave_addr, uint16_t* ret);
152+
153+// DEPRECATED - DO NOT USE
154+
155+#define pca9555_readPins pca9555_read_pins
156+#define pca9555_readPins_all pca9555_read_pins_all
157diff --git a/keyboards/geistmaschine/macropod/matrix.c b/keyboards/geistmaschine/macropod/matrix.c
158index 60b1dafe637185b2b16d8049fadd4336d9fd63ab..ebc10e2e5addc2706c7c043025db29981b00f3ed 100644
159--- a/keyboards/geistmaschine/macropod/matrix.c
160+++ b/keyboards/geistmaschine/macropod/matrix.c
161@@ -55,7 +55,7 @@ bool matrix_scan_custom(matrix_row_t current_matrix[]) {
162             pca9555_setup();
163         }
164         // Read the entire port into this byte, 1 = not pressed, 0 = pressed
165-        bool ret = pca9555_readPins(IC1, PCA9555_PORT0, &pin_states);
166+        bool ret = pca9555_read_pins(IC1, PCA9555_PORT0, &pin_states);
167 
168         // Update state
169         if (ret) {
170diff --git a/keyboards/ktec/ergodone/matrix.c b/keyboards/ktec/ergodone/matrix.c
171index cb845db1bc7dbe57f34f468522bd5ab917b05a7a..a9a517f2f125a9ee806aa4117fa6610928b7d880 100644
172--- a/keyboards/ktec/ergodone/matrix.c
173+++ b/keyboards/ktec/ergodone/matrix.c
174@@ -49,7 +49,7 @@ static matrix_row_t expander_read_row(void) {
175     }
176 
177     uint8_t ret = 0xFF;
178-    mcp23018_errors += !mcp23018_readPins(I2C_ADDR, mcp23018_PORTA, &ret);
179+    mcp23018_errors += !mcp23018_read_pins(I2C_ADDR, mcp23018_PORTA, &ret);
180 
181     ret = bitrev(~ret);
182     ret = ((ret & 0b11111000) >> 1) | (ret & 0b00000011);
183diff --git a/keyboards/mechwild/sugarglider/matrix.c b/keyboards/mechwild/sugarglider/matrix.c
184index c76a8345d3b245346b5f15c5aa31e5629a7ddfa4..2fa384ed227e52095f8c389be7f3dbcf5de69914 100644
185--- a/keyboards/mechwild/sugarglider/matrix.c
186+++ b/keyboards/mechwild/sugarglider/matrix.c
187@@ -38,7 +38,7 @@ static matrix_row_t read_cols(void) {
188     }
189 
190     uint8_t ret = 0xFF;                                                         // sets all to 1
191-    mcp23018_errors += !mcp23018_readPins(I2C_ADDR, mcp23018_PORTB, &ret);      // will update with values 0 = pulled down by connection, 1 = pulled up by pullup resistors
192+    mcp23018_errors += !mcp23018_read_pins(I2C_ADDR, mcp23018_PORTB, &ret);      // will update with values 0 = pulled down by connection, 1 = pulled up by pullup resistors
193 
194     return (~ret) & 0b00111111; // Clears out the two row bits in the B buffer.
195 }
196diff --git a/keyboards/moon/matrix.c b/keyboards/moon/matrix.c
197index bb46e1b576f1b5abe25c96a52d8a130f93ee5068..8c9b6214dbaa4e3fc7b6b4a0fe9ed4142eb67ab6 100644
198--- a/keyboards/moon/matrix.c
199+++ b/keyboards/moon/matrix.c
200@@ -145,8 +145,8 @@ static void select_row(uint8_t row) {
201 static uint16_t read_cols(void) {
202   uint8_t state_1 = 0;
203   uint8_t state_2 = 0;
204-  pca9555_readPins(IC2, PCA9555_PORT0, &state_1);
205-  pca9555_readPins(IC2, PCA9555_PORT1, &state_2);
206+  pca9555_read_pins(IC2, PCA9555_PORT0, &state_1);
207+  pca9555_read_pins(IC2, PCA9555_PORT1, &state_2);
208 
209   uint16_t state = (((uint16_t)state_1 & PORT0_COLS_MASK) << 3) | (((uint16_t)state_2 & PORT1_COLS_MASK));
210 
211diff --git a/keyboards/switchplate/southpaw_65/matrix.c b/keyboards/switchplate/southpaw_65/matrix.c
212index e24dcef853530dac2faa4de50d6b28ccaf6a11b3..a7008e9c7d0c32eca3172bab99ca86c2139ebb65 100644
213--- a/keyboards/switchplate/southpaw_65/matrix.c
214+++ b/keyboards/switchplate/southpaw_65/matrix.c
215@@ -54,9 +54,9 @@ static uint32_t read_cols(void) {
216     uint8_t state_1 = 0;
217     uint8_t state_2 = 0;
218     uint8_t state_3 = 0;
219-    pca9555_readPins(IC1, PCA9555_PORT1, &state_1);
220-    pca9555_readPins(IC2, PCA9555_PORT0, &state_2);
221-    pca9555_readPins(IC2, PCA9555_PORT1, &state_3);
222+    pca9555_read_pins(IC1, PCA9555_PORT1, &state_1);
223+    pca9555_read_pins(IC2, PCA9555_PORT0, &state_2);
224+    pca9555_read_pins(IC2, PCA9555_PORT1, &state_3);
225 
226     uint32_t state = ((((uint32_t)state_3 & 0b01111111) << 12) | ((uint32_t)state_2 << 4) | (((uint32_t)state_1 & 0b11110000) >> 4));
227     return ~state;
228diff --git a/keyboards/viktus/sp111/matrix.c b/keyboards/viktus/sp111/matrix.c
229index 33b232dca77b267e8de3d4f1c1010e836942dd1c..a39365cef60e5af75205607afe4708a0b303e91d 100644
230--- a/keyboards/viktus/sp111/matrix.c
231+++ b/keyboards/viktus/sp111/matrix.c
232@@ -117,7 +117,7 @@ static void select_row_MCP23018(uint8_t row) {
233 
234 static uint16_t read_cols_MCP23018(void) {
235     uint16_t tmp = 0xFFFF;
236-    mcp23018_errors += !mcp23018_readPins_all(I2C_ADDR, &tmp);
237+    mcp23018_errors += !mcp23018_read_pins_all(I2C_ADDR, &tmp);
238 
239     uint16_t state = ((tmp & 0b11111111) << 2) | ((tmp & 0b0110000000000000) >> 13);
240     return (~state) & 0b1111111111;
241diff --git a/keyboards/xiudi/xd84/matrix.c b/keyboards/xiudi/xd84/matrix.c
242index 04128561eef18cafd84687e33e7ac0a8c7fb2678..d92ac83b4a70fde9f2717d81e466c24141be764c 100644
243--- a/keyboards/xiudi/xd84/matrix.c
244+++ b/keyboards/xiudi/xd84/matrix.c
245@@ -51,10 +51,10 @@ static void select_row(uint8_t row) {
246 }
247 
248 static uint16_t read_cols(void) {
249-    // uint16_t state_1 = pca9555_readPins(IC2, PCA9555_PORT0);
250-    // uint16_t state_2 = pca9555_readPins(IC2, PCA9555_PORT1);
251+    // uint16_t state_1 = pca9555_read_pins(IC2, PCA9555_PORT0);
252+    // uint16_t state_2 = pca9555_read_pins(IC2, PCA9555_PORT1);
253     uint16_t state = 0;
254-    pca9555_readPins_all(IC2, &state);
255+    pca9555_read_pins_all(IC2, &state);
256 
257     // For the XD84 all cols are on the same IC and mapped sequentially
258     // while this technically gives 16 column reads,
259diff --git a/keyboards/xiudi/xd96/matrix.c b/keyboards/xiudi/xd96/matrix.c
260index beef7fae126f67fd9c6e658d155dbbf116d3c4ef..641202ca2c995cd654d290b6cfd4770e00d4df73 100644
261--- a/keyboards/xiudi/xd96/matrix.c
262+++ b/keyboards/xiudi/xd96/matrix.c
263@@ -53,9 +53,9 @@ static uint32_t read_cols(void) {
264   uint8_t state_1 = 0;
265   uint8_t state_2 = 0;
266   uint8_t state_3 = 0;
267-  pca9555_readPins(IC2, PCA9555_PORT0, &state_1);
268-  pca9555_readPins(IC2, PCA9555_PORT1, &state_2);
269-  pca9555_readPins(IC1, PCA9555_PORT1, &state_3);
270+  pca9555_read_pins(IC2, PCA9555_PORT0, &state_1);
271+  pca9555_read_pins(IC2, PCA9555_PORT1, &state_2);
272+  pca9555_read_pins(IC1, PCA9555_PORT1, &state_3);
273 
274   // For the XD96 the pins are mapped to port expanders as follows:
275   //   all 8 pins port 0 IC2, first 6 pins port 1 IC2, first 4 pins port 1 IC1