1 /* 2 * SD-SPI Protocol Conversion - BCMSDH->SPI Translation Layer 3 * 4 * Portions of this code are copyright (c) 2021 Cypress Semiconductor Corporation 5 * 6 * Copyright (C) 1999-2017, Broadcom Corporation 7 * 8 * Unless you and Broadcom execute a separate written software license 9 * agreement governing use of this software, this software is licensed to you 10 * under the terms of the GNU General Public License version 2 (the "GPL"), 11 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 12 * following added to such license: 13 * 14 * As a special exception, the copyright holders of this software give you 15 * permission to link this software with independent modules, and to copy and 16 * distribute the resulting executable under terms of your choice, provided that 17 * you also meet, for each linked independent module, the terms and conditions of 18 * the license of that module. An independent module is a module which is not 19 * derived from this software. The special exception does not apply to any 20 * modifications of the software. 21 * 22 * Notwithstanding the above, under no circumstances may you combine this 23 * software in any way with any other Broadcom software provided under a license 24 * other than the GPL, without Broadcom's express prior written consent. 25 * 26 * 27 * <<Broadcom-WL-IPTag/Open:>> 28 * 29 * $Id: bcmsdspi.h 514727 2014-11-12 03:02:48Z $ 30 */ 31 #ifndef _BCM_SD_SPI_H 32 #define _BCM_SD_SPI_H 33 34 /* global msglevel for debug messages - bitvals come from sdiovar.h */ 35 36 #define sd_err(x) 37 #define sd_trace(x) 38 #define sd_info(x) 39 #define sd_debug(x) 40 #define sd_data(x) 41 #define sd_ctrl(x) 42 43 #define sd_log(x) 44 45 #define SDIOH_ASSERT(exp) \ 46 do { if (!(exp)) \ 47 printf("!!!ASSERT fail: file %s lines %d", __FILE__, __LINE__); \ 48 } while (0) 49 50 #define BLOCK_SIZE_4318 64 51 #define BLOCK_SIZE_4328 512 52 53 /* internal return code */ 54 #define SUCCESS 0 55 #undef ERROR 56 #define ERROR 1 57 58 /* private bus modes */ 59 #define SDIOH_MODE_SPI 0 60 61 #define USE_BLOCKMODE 0x2 /* Block mode can be single block or multi */ 62 #define USE_MULTIBLOCK 0x4 63 64 struct sdioh_info { 65 uint cfg_bar; /* pci cfg address for bar */ 66 uint32 caps; /* cached value of capabilities reg */ 67 uint bar0; /* BAR0 for PCI Device */ 68 osl_t *osh; /* osh handler */ 69 void *bcmsdh; /* handler to upper layer stack (bcmsdh) */ 70 void *controller; /* Pointer to SPI Controller's private data struct */ 71 72 uint lockcount; /* nest count of sdspi_lock() calls */ 73 bool client_intr_enabled; /* interrupt connnected flag */ 74 bool intr_handler_valid; /* client driver interrupt handler valid */ 75 sdioh_cb_fn_t intr_handler; /* registered interrupt handler */ 76 void *intr_handler_arg; /* argument to call interrupt handler */ 77 bool initialized; /* card initialized */ 78 uint32 target_dev; /* Target device ID */ 79 uint32 intmask; /* Current active interrupts */ 80 void *sdos_info; /* Pointer to per-OS private data */ 81 82 uint32 controller_type; /* Host controller type */ 83 uint8 version; /* Host Controller Spec Compliance Version */ 84 uint irq; /* Client irq */ 85 uint32 intrcount; /* Client interrupts */ 86 uint32 local_intrcount; /* Controller interrupts */ 87 bool host_init_done; /* Controller initted */ 88 bool card_init_done; /* Client SDIO interface initted */ 89 bool polled_mode; /* polling for command completion */ 90 91 bool sd_use_dma; /* DMA on CMD53 */ 92 bool sd_blockmode; /* sd_blockmode == FALSE => 64 Byte Cmd 53s. */ 93 /* Must be on for sd_multiblock to be effective */ 94 bool use_client_ints; /* If this is false, make sure to restore */ 95 bool got_hcint; /* Host Controller interrupt. */ 96 /* polling hack in wl_linux.c:wl_timer() */ 97 int adapter_slot; /* Maybe dealing with multiple slots/controllers */ 98 int sd_mode; /* SD1/SD4/SPI */ 99 int client_block_size[SDIOD_MAX_IOFUNCS]; /* Blocksize */ 100 uint32 data_xfer_count; /* Current register transfer size */ 101 uint32 cmd53_wr_data; /* Used to pass CMD53 write data */ 102 uint32 card_response; /* Used to pass back response status byte */ 103 uint32 card_rsp_data; /* Used to pass back response data word */ 104 uint16 card_rca; /* Current Address */ 105 uint8 num_funcs; /* Supported funcs on client */ 106 uint32 com_cis_ptr; 107 uint32 func_cis_ptr[SDIOD_MAX_IOFUNCS]; 108 void *dma_buf; 109 ulong dma_phys; 110 int r_cnt; /* rx count */ 111 int t_cnt; /* tx_count */ 112 }; 113 114 /************************************************************ 115 * Internal interfaces: per-port references into bcmsdspi.c 116 */ 117 118 /* Global message bits */ 119 extern uint sd_msglevel; 120 121 /************************************************************** 122 * Internal interfaces: bcmsdspi.c references to per-port code 123 */ 124 125 /* Register mapping routines */ 126 extern uint32 *spi_reg_map(osl_t *osh, uintptr addr, int size); 127 extern void spi_reg_unmap(osl_t *osh, uintptr addr, int size); 128 129 /* Interrupt (de)registration routines */ 130 extern int spi_register_irq(sdioh_info_t *sd, uint irq); 131 extern void spi_free_irq(uint irq, sdioh_info_t *sd); 132 133 /* OS-specific interrupt wrappers (atomic interrupt enable/disable) */ 134 extern void spi_lock(sdioh_info_t *sd); 135 extern void spi_unlock(sdioh_info_t *sd); 136 137 /* Allocate/init/free per-OS private data */ 138 extern int spi_osinit(sdioh_info_t *sd); 139 extern void spi_osfree(sdioh_info_t *sd); 140 141 #endif /* _BCM_SD_SPI_H */ 142