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