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/time.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 #include "trace.h" 50 #include "general.h" 51 52 #define CR_DRIVER_NAME "rts5208" 53 54 #define pci_get_bus_and_slot(bus, devfn) \ 55 pci_get_domain_bus_and_slot(0, (bus), (devfn)) 56 57 /* 58 * macros for easy use 59 */ 60 #define rtsx_writel(chip, reg, value) \ 61 iowrite32(value, (chip)->rtsx->remap_addr + reg) 62 #define rtsx_readl(chip, reg) \ 63 ioread32((chip)->rtsx->remap_addr + reg) 64 #define rtsx_writew(chip, reg, value) \ 65 iowrite16(value, (chip)->rtsx->remap_addr + reg) 66 #define rtsx_readw(chip, reg) \ 67 ioread16((chip)->rtsx->remap_addr + reg) 68 #define rtsx_writeb(chip, reg, value) \ 69 iowrite8(value, (chip)->rtsx->remap_addr + reg) 70 #define rtsx_readb(chip, reg) \ 71 ioread8((chip)->rtsx->remap_addr + reg) 72 73 #define rtsx_read_config_byte(chip, where, val) \ 74 pci_read_config_byte((chip)->rtsx->pci, where, val) 75 76 #define rtsx_write_config_byte(chip, where, val) \ 77 pci_write_config_byte((chip)->rtsx->pci, where, val) 78 79 #define wait_timeout_x(task_state, msecs) \ 80 do { \ 81 set_current_state((task_state)); \ 82 schedule_timeout((msecs) * HZ / 1000); \ 83 } while (0) 84 #define wait_timeout(msecs) wait_timeout_x(TASK_INTERRUPTIBLE, (msecs)) 85 86 87 #define STATE_TRANS_NONE 0 88 #define STATE_TRANS_CMD 1 89 #define STATE_TRANS_BUF 2 90 #define STATE_TRANS_SG 3 91 92 #define TRANS_NOT_READY 0 93 #define TRANS_RESULT_OK 1 94 #define TRANS_RESULT_FAIL 2 95 96 #define SCSI_LUN(srb) ((srb)->device->lun) 97 98 typedef unsigned long DELAY_PARA_T; 99 100 struct rtsx_chip; 101 102 struct rtsx_dev { 103 struct pci_dev *pci; 104 105 /* pci resources */ 106 unsigned long addr; 107 void __iomem *remap_addr; 108 int irq; 109 110 /* locks */ 111 spinlock_t reg_lock; 112 113 struct task_struct *ctl_thread; /* the control thread */ 114 struct task_struct *polling_thread; /* the polling thread */ 115 116 /* mutual exclusion and synchronization structures */ 117 struct completion cmnd_ready; /* to sleep thread on */ 118 struct completion control_exit; /* control thread exit */ 119 struct completion polling_exit; /* polling thread exit */ 120 struct completion notify; /* thread begin/end */ 121 struct completion scanning_done; /* wait for scan thread */ 122 123 wait_queue_head_t delay_wait; /* wait during scan, reset */ 124 struct mutex dev_mutex; 125 126 /* host reserved buffer */ 127 void *rtsx_resv_buf; 128 dma_addr_t rtsx_resv_buf_addr; 129 130 char trans_result; 131 char trans_state; 132 133 struct completion *done; 134 /* Whether interrupt handler should care card cd info */ 135 u32 check_card_cd; 136 137 struct rtsx_chip *chip; 138 }; 139 140 typedef struct rtsx_dev rtsx_dev_t; 141 142 /* Convert between rtsx_dev and the corresponding Scsi_Host */ 143 static inline struct Scsi_Host *rtsx_to_host(struct rtsx_dev *dev) 144 { 145 return container_of((void *) dev, struct Scsi_Host, hostdata); 146 } 147 static inline struct rtsx_dev *host_to_rtsx(struct Scsi_Host *host) 148 { 149 return (struct rtsx_dev *) host->hostdata; 150 } 151 152 static inline void get_current_time(u8 *timeval_buf, int buf_len) 153 { 154 struct timeval tv; 155 156 if (!timeval_buf || (buf_len < 8)) 157 return; 158 159 do_gettimeofday(&tv); 160 161 timeval_buf[0] = (u8)(tv.tv_sec >> 24); 162 timeval_buf[1] = (u8)(tv.tv_sec >> 16); 163 timeval_buf[2] = (u8)(tv.tv_sec >> 8); 164 timeval_buf[3] = (u8)(tv.tv_sec); 165 timeval_buf[4] = (u8)(tv.tv_usec >> 24); 166 timeval_buf[5] = (u8)(tv.tv_usec >> 16); 167 timeval_buf[6] = (u8)(tv.tv_usec >> 8); 168 timeval_buf[7] = (u8)(tv.tv_usec); 169 } 170 171 /* The scsi_lock() and scsi_unlock() macros protect the sm_state and the 172 * single queue element srb for write access */ 173 #define scsi_unlock(host) spin_unlock_irq(host->host_lock) 174 #define scsi_lock(host) spin_lock_irq(host->host_lock) 175 176 #define lock_state(chip) spin_lock_irq(&((chip)->rtsx->reg_lock)) 177 #define unlock_state(chip) spin_unlock_irq(&((chip)->rtsx->reg_lock)) 178 179 /* struct scsi_cmnd transfer buffer access utilities */ 180 enum xfer_buf_dir {TO_XFER_BUF, FROM_XFER_BUF}; 181 182 int rtsx_read_pci_cfg_byte(u8 bus, u8 dev, u8 func, u8 offset, u8 *val); 183 184 #endif /* __REALTEK_RTSX_H */ 185