1f1789286SStefan Wahren /* 2f1789286SStefan Wahren * Copyright (c) 2011, 2012, Atheros Communications Inc. 3f1789286SStefan Wahren * Copyright (c) 2014, I2SE GmbH 4f1789286SStefan Wahren * 5f1789286SStefan Wahren * Permission to use, copy, modify, and/or distribute this software 6f1789286SStefan Wahren * for any purpose with or without fee is hereby granted, provided 7f1789286SStefan Wahren * that the above copyright notice and this permission notice appear 8f1789286SStefan Wahren * in all copies. 9f1789286SStefan Wahren * 10f1789286SStefan Wahren * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 11f1789286SStefan Wahren * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 12f1789286SStefan Wahren * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL 13f1789286SStefan Wahren * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR 14f1789286SStefan Wahren * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 15f1789286SStefan Wahren * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 16f1789286SStefan Wahren * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 17f1789286SStefan Wahren * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18f1789286SStefan Wahren */ 19f1789286SStefan Wahren 20f1789286SStefan Wahren /* Atheros Ethernet framing. Every Ethernet frame is surrounded by an atheros 21f1789286SStefan Wahren * frame while transmitted over a serial channel. 22f1789286SStefan Wahren */ 23f1789286SStefan Wahren 24f1789286SStefan Wahren #ifndef _QCA_FRAMING_H 25f1789286SStefan Wahren #define _QCA_FRAMING_H 26f1789286SStefan Wahren 27f1789286SStefan Wahren #include <linux/if_ether.h> 28f1789286SStefan Wahren #include <linux/if_vlan.h> 29f1789286SStefan Wahren #include <linux/types.h> 30f1789286SStefan Wahren 31f1789286SStefan Wahren /* Frame is currently being received */ 32f1789286SStefan Wahren #define QCAFRM_GATHER 0 33f1789286SStefan Wahren 34f1789286SStefan Wahren /* No header byte while expecting it */ 35f1789286SStefan Wahren #define QCAFRM_NOHEAD (QCAFRM_ERR_BASE - 1) 36f1789286SStefan Wahren 37f1789286SStefan Wahren /* No tailer byte while expecting it */ 38f1789286SStefan Wahren #define QCAFRM_NOTAIL (QCAFRM_ERR_BASE - 2) 39f1789286SStefan Wahren 40f1789286SStefan Wahren /* Frame length is invalid */ 41f1789286SStefan Wahren #define QCAFRM_INVLEN (QCAFRM_ERR_BASE - 3) 42f1789286SStefan Wahren 43f1789286SStefan Wahren /* Frame length is invalid */ 44f1789286SStefan Wahren #define QCAFRM_INVFRAME (QCAFRM_ERR_BASE - 4) 45f1789286SStefan Wahren 46f1789286SStefan Wahren /* Min/Max Ethernet MTU: 46/1500 */ 47f1789286SStefan Wahren #define QCAFRM_MIN_MTU (ETH_ZLEN - ETH_HLEN) 48f1789286SStefan Wahren #define QCAFRM_MAX_MTU ETH_DATA_LEN 49f1789286SStefan Wahren 50f1789286SStefan Wahren /* Min/Max frame lengths */ 51f1789286SStefan Wahren #define QCAFRM_MIN_LEN (QCAFRM_MIN_MTU + ETH_HLEN) 52f1789286SStefan Wahren #define QCAFRM_MAX_LEN (QCAFRM_MAX_MTU + VLAN_ETH_HLEN) 53f1789286SStefan Wahren 54f1789286SStefan Wahren /* QCA7K header len */ 55f1789286SStefan Wahren #define QCAFRM_HEADER_LEN 8 56f1789286SStefan Wahren 57f1789286SStefan Wahren /* QCA7K footer len */ 58f1789286SStefan Wahren #define QCAFRM_FOOTER_LEN 2 59f1789286SStefan Wahren 60f1789286SStefan Wahren /* QCA7K Framing. */ 61f1789286SStefan Wahren #define QCAFRM_ERR_BASE -1000 62f1789286SStefan Wahren 63f1789286SStefan Wahren enum qcafrm_state { 6460d67024SStefan Wahren /* HW length is only available on SPI */ 65f1789286SStefan Wahren QCAFRM_HW_LEN0 = 0x8000, 66f1789286SStefan Wahren QCAFRM_HW_LEN1 = QCAFRM_HW_LEN0 - 1, 67f1789286SStefan Wahren QCAFRM_HW_LEN2 = QCAFRM_HW_LEN1 - 1, 68f1789286SStefan Wahren QCAFRM_HW_LEN3 = QCAFRM_HW_LEN2 - 1, 69f1789286SStefan Wahren 70f1789286SStefan Wahren /* Waiting first 0xAA of header */ 71f1789286SStefan Wahren QCAFRM_WAIT_AA1 = QCAFRM_HW_LEN3 - 1, 72f1789286SStefan Wahren 73f1789286SStefan Wahren /* Waiting second 0xAA of header */ 74f1789286SStefan Wahren QCAFRM_WAIT_AA2 = QCAFRM_WAIT_AA1 - 1, 75f1789286SStefan Wahren 76f1789286SStefan Wahren /* Waiting third 0xAA of header */ 77f1789286SStefan Wahren QCAFRM_WAIT_AA3 = QCAFRM_WAIT_AA2 - 1, 78f1789286SStefan Wahren 79f1789286SStefan Wahren /* Waiting fourth 0xAA of header */ 80f1789286SStefan Wahren QCAFRM_WAIT_AA4 = QCAFRM_WAIT_AA3 - 1, 81f1789286SStefan Wahren 82f1789286SStefan Wahren /* Waiting Byte 0-1 of length (litte endian) */ 83f1789286SStefan Wahren QCAFRM_WAIT_LEN_BYTE0 = QCAFRM_WAIT_AA4 - 1, 84f1789286SStefan Wahren QCAFRM_WAIT_LEN_BYTE1 = QCAFRM_WAIT_AA4 - 2, 85f1789286SStefan Wahren 86f1789286SStefan Wahren /* Reserved bytes */ 87f1789286SStefan Wahren QCAFRM_WAIT_RSVD_BYTE1 = QCAFRM_WAIT_AA4 - 3, 88f1789286SStefan Wahren QCAFRM_WAIT_RSVD_BYTE2 = QCAFRM_WAIT_AA4 - 4, 89f1789286SStefan Wahren 90f1789286SStefan Wahren /* The frame length is used as the state until 91f1789286SStefan Wahren * the end of the Ethernet frame 92f1789286SStefan Wahren * Waiting for first 0x55 of footer 93f1789286SStefan Wahren */ 94f1789286SStefan Wahren QCAFRM_WAIT_551 = 1, 95f1789286SStefan Wahren 96f1789286SStefan Wahren /* Waiting for second 0x55 of footer */ 97f1789286SStefan Wahren QCAFRM_WAIT_552 = QCAFRM_WAIT_551 - 1 98f1789286SStefan Wahren }; 99f1789286SStefan Wahren 100f1789286SStefan Wahren /* Structure to maintain the frame decoding during reception. */ 101f1789286SStefan Wahren 102f1789286SStefan Wahren struct qcafrm_handle { 103f1789286SStefan Wahren /* Current decoding state */ 104f1789286SStefan Wahren enum qcafrm_state state; 10560d67024SStefan Wahren /* Initial state depends on connection type */ 10660d67024SStefan Wahren enum qcafrm_state init; 107f1789286SStefan Wahren 108f1789286SStefan Wahren /* Offset in buffer (borrowed for length too) */ 109f1789286SStefan Wahren u16 offset; 110f1789286SStefan Wahren 111f1789286SStefan Wahren /* Frame length as kept by this module */ 112f1789286SStefan Wahren u16 len; 113f1789286SStefan Wahren }; 114f1789286SStefan Wahren 115f1789286SStefan Wahren u16 qcafrm_create_header(u8 *buf, u16 len); 116f1789286SStefan Wahren 117f1789286SStefan Wahren u16 qcafrm_create_footer(u8 *buf); 118f1789286SStefan Wahren 11960d67024SStefan Wahren static inline void qcafrm_fsm_init_spi(struct qcafrm_handle *handle) 120f1789286SStefan Wahren { 12160d67024SStefan Wahren handle->init = QCAFRM_HW_LEN0; 12260d67024SStefan Wahren handle->state = handle->init; 123f1789286SStefan Wahren } 124f1789286SStefan Wahren 125f1789286SStefan Wahren /* Gather received bytes and try to extract a full Ethernet frame 126f1789286SStefan Wahren * by following a simple state machine. 127f1789286SStefan Wahren * 128f1789286SStefan Wahren * Return: QCAFRM_GATHER No Ethernet frame fully received yet. 129f1789286SStefan Wahren * QCAFRM_NOHEAD Header expected but not found. 130f1789286SStefan Wahren * QCAFRM_INVLEN QCA7K frame length is invalid 131f1789286SStefan Wahren * QCAFRM_NOTAIL Footer expected but not found. 132f1789286SStefan Wahren * > 0 Number of byte in the fully received 133f1789286SStefan Wahren * Ethernet frame 134f1789286SStefan Wahren */ 135f1789286SStefan Wahren 136f1789286SStefan Wahren s32 qcafrm_fsm_decode(struct qcafrm_handle *handle, u8 *buf, u16 buf_len, u8 recv_byte); 137f1789286SStefan Wahren 138f1789286SStefan Wahren #endif /* _QCA_FRAMING_H */ 139