1 /* Driver for Realtek PCI-Express card reader 2 * Header file 3 * 4 * Copyright(c) 2009-2013 Realtek Semiconductor Corp. All rights reserved. 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms of the GNU General Public License as published by the 8 * Free Software Foundation; either version 2, or (at your option) any 9 * later version. 10 * 11 * This program is distributed in the hope that it will be useful, but 12 * WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 * General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License along 17 * with this program; if not, see <http://www.gnu.org/licenses/>. 18 * 19 * Author: 20 * Wei WANG (wei_wang@realsil.com.cn) 21 * Micky Ching (micky_ching@realsil.com.cn) 22 */ 23 24 #ifndef __REALTEK_RTSX_H 25 #define __REALTEK_RTSX_H 26 27 #include <linux/io.h> 28 #include <linux/bitops.h> 29 #include <linux/delay.h> 30 #include <linux/interrupt.h> 31 #include <linux/kernel.h> 32 #include <linux/module.h> 33 #include <linux/moduleparam.h> 34 #include <linux/slab.h> 35 #include <linux/pci.h> 36 #include <linux/mutex.h> 37 #include <linux/cdrom.h> 38 #include <linux/workqueue.h> 39 #include <linux/timer.h> 40 #include <linux/time64.h> 41 42 #include <scsi/scsi.h> 43 #include <scsi/scsi_cmnd.h> 44 #include <scsi/scsi_device.h> 45 #include <scsi/scsi_devinfo.h> 46 #include <scsi/scsi_eh.h> 47 #include <scsi/scsi_host.h> 48 49 #define CR_DRIVER_NAME "rts5208" 50 51 /* 52 * macros for easy use 53 */ 54 #define rtsx_writel(chip, reg, value) \ 55 iowrite32(value, (chip)->rtsx->remap_addr + reg) 56 #define rtsx_readl(chip, reg) \ 57 ioread32((chip)->rtsx->remap_addr + reg) 58 #define rtsx_writew(chip, reg, value) \ 59 iowrite16(value, (chip)->rtsx->remap_addr + reg) 60 #define rtsx_readw(chip, reg) \ 61 ioread16((chip)->rtsx->remap_addr + reg) 62 #define rtsx_writeb(chip, reg, value) \ 63 iowrite8(value, (chip)->rtsx->remap_addr + reg) 64 #define rtsx_readb(chip, reg) \ 65 ioread8((chip)->rtsx->remap_addr + reg) 66 67 #define rtsx_read_config_byte(chip, where, val) \ 68 pci_read_config_byte((chip)->rtsx->pci, where, val) 69 70 #define rtsx_write_config_byte(chip, where, val) \ 71 pci_write_config_byte((chip)->rtsx->pci, where, val) 72 73 #define wait_timeout_x(task_state, msecs) \ 74 do { \ 75 set_current_state((task_state)); \ 76 schedule_timeout((msecs) * HZ / 1000); \ 77 } while (0) 78 #define wait_timeout(msecs) wait_timeout_x(TASK_INTERRUPTIBLE, (msecs)) 79 80 #define STATE_TRANS_NONE 0 81 #define STATE_TRANS_CMD 1 82 #define STATE_TRANS_BUF 2 83 #define STATE_TRANS_SG 3 84 85 #define TRANS_NOT_READY 0 86 #define TRANS_RESULT_OK 1 87 #define TRANS_RESULT_FAIL 2 88 89 #define SCSI_LUN(srb) ((srb)->device->lun) 90 91 struct rtsx_chip; 92 93 struct rtsx_dev { 94 struct pci_dev *pci; 95 96 /* pci resources */ 97 unsigned long addr; 98 void __iomem *remap_addr; 99 int irq; 100 101 /* locks */ 102 spinlock_t reg_lock; 103 104 struct task_struct *ctl_thread; /* the control thread */ 105 struct task_struct *polling_thread; /* the polling thread */ 106 107 /* mutual exclusion and synchronization structures */ 108 struct completion cmnd_ready; /* to sleep thread on */ 109 struct completion control_exit; /* control thread exit */ 110 struct completion polling_exit; /* polling thread exit */ 111 struct completion notify; /* thread begin/end */ 112 struct completion scanning_done; /* wait for scan thread */ 113 114 wait_queue_head_t delay_wait; /* wait during scan, reset */ 115 struct mutex dev_mutex; 116 117 /* host reserved buffer */ 118 void *rtsx_resv_buf; 119 dma_addr_t rtsx_resv_buf_addr; 120 121 char trans_result; 122 char trans_state; 123 124 struct completion *done; 125 /* Whether interrupt handler should care card cd info */ 126 u32 check_card_cd; 127 128 struct rtsx_chip *chip; 129 }; 130 131 /* Convert between rtsx_dev and the corresponding Scsi_Host */ 132 static inline struct Scsi_Host *rtsx_to_host(struct rtsx_dev *dev) 133 { 134 return container_of((void *)dev, struct Scsi_Host, hostdata); 135 } 136 137 static inline struct rtsx_dev *host_to_rtsx(struct Scsi_Host *host) 138 { 139 return (struct rtsx_dev *)host->hostdata; 140 } 141 142 static inline void get_current_time(u8 *timeval_buf, int buf_len) 143 { 144 struct timespec64 ts64; 145 u32 tv_usec; 146 147 if (!timeval_buf || (buf_len < 8)) 148 return; 149 150 getnstimeofday64(&ts64); 151 152 tv_usec = ts64.tv_nsec / NSEC_PER_USEC; 153 154 timeval_buf[0] = (u8)(ts64.tv_sec >> 24); 155 timeval_buf[1] = (u8)(ts64.tv_sec >> 16); 156 timeval_buf[2] = (u8)(ts64.tv_sec >> 8); 157 timeval_buf[3] = (u8)(ts64.tv_sec); 158 timeval_buf[4] = (u8)(tv_usec >> 24); 159 timeval_buf[5] = (u8)(tv_usec >> 16); 160 timeval_buf[6] = (u8)(tv_usec >> 8); 161 timeval_buf[7] = (u8)(tv_usec); 162 } 163 164 /* 165 * The scsi_lock() and scsi_unlock() macros protect the sm_state and the 166 * single queue element srb for write access 167 */ 168 #define scsi_unlock(host) spin_unlock_irq(host->host_lock) 169 #define scsi_lock(host) spin_lock_irq(host->host_lock) 170 171 #define lock_state(chip) spin_lock_irq(&((chip)->rtsx->reg_lock)) 172 #define unlock_state(chip) spin_unlock_irq(&((chip)->rtsx->reg_lock)) 173 174 /* struct scsi_cmnd transfer buffer access utilities */ 175 enum xfer_buf_dir {TO_XFER_BUF, FROM_XFER_BUF}; 176 177 #define _MSG_TRACE 178 179 #include "trace.h" 180 #include "rtsx_chip.h" 181 #include "rtsx_transport.h" 182 #include "rtsx_scsi.h" 183 #include "rtsx_card.h" 184 #include "rtsx_sys.h" 185 #include "general.h" 186 187 #endif /* __REALTEK_RTSX_H */ 188