1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2019 Intel Corporation
6 #include "ifpga_compat.h"
8 /*transaction opcodes*/
9 #define SPI_TRAN_SEQ_WRITE 0x04 /* SPI transaction sequential write */
10 #define SPI_TRAN_SEQ_READ 0x14 /* SPI transaction sequential read */
11 #define SPI_TRAN_NON_SEQ_WRITE 0x00 /* SPI transaction non-sequential write */
12 #define SPI_TRAN_NON_SEQ_READ 0x10 /* SPI transaction non-sequential read*/
14 /*specail packet characters*/
15 #define SPI_PACKET_SOP 0x7a
16 #define SPI_PACKET_EOP 0x7b
17 #define SPI_PACKET_CHANNEL 0x7c
18 #define SPI_PACKET_ESC 0x7d
20 /*special byte characters*/
21 #define SPI_BYTE_IDLE 0x4a
22 #define SPI_BYTE_ESC 0x4d
24 #define SPI_REG_BYTES 4
26 #define INIT_SPI_TRAN_HEADER(trans_type, size, address) \
28 header.trans_type = trans_type; \
30 header.size = cpu_to_be16(size); \
31 header.addr = cpu_to_be32(addr); \
35 static void print_buffer(const char *string, void *buffer, int len)
38 unsigned char *p = buffer;
40 printf("%s print buffer, len=%d\n", string, len);
42 for (i = 0; i < len; i++)
43 printf("%x ", *(p+i));
47 static void print_buffer(const char *string, void *buffer, int len)
55 static unsigned char xor_20(unsigned char val)
60 static void reorder_phy_data(u8 bits_per_word,
61 void *buf, unsigned int len)
63 unsigned int count = len / (bits_per_word/8);
66 if (bits_per_word == 32) {
81 static int resp_find_sop_eop(unsigned char *resp, unsigned int len,
84 int ret = SPI_NOT_FOUND;
86 unsigned char *b = resp;
89 if (flags != SPI_FOUND_SOP) {
90 while (b < resp + len && *b != SPI_PACKET_SOP)
93 if (*b != SPI_PACKET_SOP)
100 while (b < resp + len && *b != SPI_PACKET_EOP)
103 if (*b != SPI_PACKET_EOP)
112 static void phy_tx_pad(unsigned char *phy_buf, unsigned int phy_buf_len,
113 unsigned int *aligned_len)
115 unsigned char *p = &phy_buf[phy_buf_len - 1], *dst_p;
117 *aligned_len = IFPGA_ALIGN(phy_buf_len, 4);
119 if (*aligned_len == phy_buf_len)
122 dst_p = &phy_buf[*aligned_len - 1];
124 /* move EOP and bytes after EOP to the end of aligned size */
125 while (p > phy_buf) {
128 if (*p == SPI_PACKET_EOP)
135 /* fill the hole with PHY_IDLE */
137 *p++ = SPI_BYTE_IDLE;
140 static int byte_to_core_convert(struct spi_transaction_dev *dev,
141 unsigned int send_len, unsigned char *send_data,
142 unsigned int resp_len, unsigned char *resp_data,
143 unsigned int *valid_resp_len)
147 unsigned char *send_packet = dev->buffer->bytes_send;
148 unsigned char *resp_packet = dev->buffer->bytes_resp;
150 unsigned char current_byte;
151 unsigned char *tx_buffer;
152 unsigned int tx_len = 0;
153 unsigned char *rx_buffer;
154 unsigned int rx_len = 0;
157 unsigned long timeout = msecs_to_timer_cycles(1000);
159 unsigned int resp_max_len = 2 * resp_len;
161 print_buffer("before bytes:", send_data, send_len);
165 for (i = 0; i < send_len; i++) {
166 current_byte = send_data[i];
167 switch (current_byte) {
170 *p++ = xor_20(current_byte);
174 *p++ = xor_20(current_byte);
182 tx_len = p - send_packet;
184 print_buffer("before spi:", send_packet, tx_len);
186 phy_tx_pad(send_packet, tx_len, &tx_len);
187 print_buffer("after pad:", send_packet, tx_len);
189 reorder_phy_data(32, send_packet, tx_len);
191 print_buffer("after order to spi:", send_packet, tx_len);
194 tx_buffer = send_packet;
195 rx_buffer = resp_packet;
196 rx_len = resp_max_len;
197 spi_flags = SPI_NOT_FOUND;
200 ret = spi_command(dev->dev, dev->chipselect, tx_len, tx_buffer,
205 print_buffer("read from spi:", rx_buffer, rx_len);
207 /* look for SOP firstly*/
208 ret = resp_find_sop_eop(rx_buffer, rx_len - 1, spi_flags);
209 if (ret != SPI_FOUND_EOP) {
212 ticks = rte_get_timer_cycles();
213 if (time_after(ticks, timeout) &&
214 retry++ > SPI_MAX_RETRY) {
215 dev_err(NULL, "Have retry %d, found invalid packet data\n",
220 if (ret == SPI_FOUND_SOP) {
222 resp_max_len += rx_len;
229 print_buffer("found valid data:", resp_packet, resp_max_len);
231 /* analyze response packet */
234 while (i < resp_max_len) {
235 current_byte = resp_packet[i];
236 switch (current_byte) {
242 current_byte = resp_packet[i];
243 *p++ = xor_20(current_byte);
253 /* receive "4a" means the SPI is idle, not valid data */
254 *valid_resp_len = p - resp_data;
255 if (*valid_resp_len == 0) {
256 dev_err(NULL, "error: repond package without valid data\n");
263 static int packet_to_byte_conver(struct spi_transaction_dev *dev,
264 unsigned int send_len, unsigned char *send_buf,
265 unsigned int resp_len, unsigned char *resp_buf,
270 unsigned char current_byte;
271 unsigned int resp_max_len;
272 unsigned char *send_packet = dev->buffer->packet_send;
273 unsigned char *resp_packet = dev->buffer->packet_resp;
275 unsigned int valid_resp_len = 0;
277 print_buffer("before packet:", send_buf, send_len);
279 resp_max_len = 2 * resp_len + 4;
284 *p++ = SPI_PACKET_SOP;
286 *p++ = SPI_PACKET_CHANNEL;
289 /* append the data into a packet */
290 for (i = 0; i < send_len; i++) {
291 current_byte = send_buf[i];
293 /* EOP for last byte */
294 if (i == send_len - 1)
295 *p++ = SPI_PACKET_EOP;
297 switch (current_byte) {
300 case SPI_PACKET_CHANNEL:
302 *p++ = SPI_PACKET_ESC;
303 *p++ = xor_20(current_byte);
310 ret = byte_to_core_convert(dev, p - send_packet,
311 send_packet, resp_max_len, resp_packet,
316 print_buffer("after byte conver:", resp_packet, valid_resp_len);
318 /* analyze the response packet */
322 for (i = 0; i < valid_resp_len; i++) {
323 if (resp_packet[i] == SPI_PACKET_SOP)
327 if (i == valid_resp_len) {
328 dev_err(NULL, "error on analyze response packet 0x%x\n",
335 /* continue parsing data after SOP */
336 while (i < valid_resp_len) {
337 current_byte = resp_packet[i];
339 switch (current_byte) {
341 case SPI_PACKET_CHANNEL:
344 current_byte = resp_packet[i];
345 *p++ = xor_20(current_byte);
350 current_byte = resp_packet[i];
351 if (current_byte == SPI_PACKET_ESC ||
352 current_byte == SPI_PACKET_CHANNEL ||
353 current_byte == SPI_PACKET_SOP) {
355 current_byte = resp_packet[i];
356 *p++ = xor_20(current_byte);
368 *valid = p - resp_buf;
370 print_buffer("after packet:", resp_buf, *valid);
375 static int do_transaction(struct spi_transaction_dev *dev, unsigned int addr,
376 unsigned int size, unsigned char *data,
377 unsigned int trans_type)
380 struct spi_tran_header header;
381 unsigned char *transaction = dev->buffer->tran_send;
382 unsigned char *response = dev->buffer->tran_resp;
386 unsigned int valid_len = 0;
388 /* make transacation header */
389 INIT_SPI_TRAN_HEADER(trans_type, size, addr);
391 /* fill the header */
393 opae_memcpy(p, &header, sizeof(struct spi_tran_header));
394 p = p + sizeof(struct spi_tran_header);
396 switch (trans_type) {
397 case SPI_TRAN_SEQ_WRITE:
398 case SPI_TRAN_NON_SEQ_WRITE:
399 for (i = 0; i < size; i++)
402 ret = packet_to_byte_conver(dev, size + HEADER_LEN,
403 transaction, RESPONSE_LEN, response,
408 /* check the result */
409 if (size != ((unsigned int)(response[2] & 0xff) << 8 |
410 (unsigned int)(response[3] & 0xff)))
414 case SPI_TRAN_SEQ_READ:
415 case SPI_TRAN_NON_SEQ_READ:
416 ret = packet_to_byte_conver(dev, HEADER_LEN,
417 transaction, size, response,
419 if (ret || valid_len != size)
422 for (i = 0; i < size; i++)
423 *data++ = *response++;
432 int spi_transaction_read(struct spi_transaction_dev *dev, unsigned int addr,
433 unsigned int size, unsigned char *data)
437 pthread_mutex_lock(&dev->lock);
438 ret = do_transaction(dev, addr, size, data,
439 (size > SPI_REG_BYTES) ?
440 SPI_TRAN_SEQ_READ : SPI_TRAN_NON_SEQ_READ);
441 pthread_mutex_unlock(&dev->lock);
446 int spi_transaction_write(struct spi_transaction_dev *dev, unsigned int addr,
447 unsigned int size, unsigned char *data)
451 pthread_mutex_lock(&dev->lock);
452 ret = do_transaction(dev, addr, size, data,
453 (size > SPI_REG_BYTES) ?
454 SPI_TRAN_SEQ_WRITE : SPI_TRAN_NON_SEQ_WRITE);
455 pthread_mutex_unlock(&dev->lock);
460 struct spi_transaction_dev *spi_transaction_init(struct altera_spi_device *dev,
463 struct spi_transaction_dev *spi_tran_dev;
466 spi_tran_dev = opae_malloc(sizeof(struct spi_transaction_dev));
470 spi_tran_dev->dev = dev;
471 spi_tran_dev->chipselect = chipselect;
473 spi_tran_dev->buffer = opae_malloc(sizeof(struct spi_tran_buffer));
474 if (!spi_tran_dev->buffer)
477 ret = pthread_mutex_init(&spi_tran_dev->lock, NULL);
479 dev_err(spi_tran_dev, "fail to init mutex lock\n");
486 opae_free(spi_tran_dev);
490 void spi_transaction_remove(struct spi_transaction_dev *dev)
492 if (dev && dev->buffer)
493 opae_free(dev->buffer);
495 pthread_mutex_destroy(&dev->lock);