1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Xilinx SDFEC 4 * 5 * Copyright (C) 2019 Xilinx, Inc. 6 * 7 * Description: 8 * This driver is developed for SDFEC16 (Soft Decision FEC 16nm) 9 * IP. It exposes a char device which supports file operations 10 * like open(), close() and ioctl(). 11 */ 12 13 #include <linux/miscdevice.h> 14 #include <linux/io.h> 15 #include <linux/interrupt.h> 16 #include <linux/kernel.h> 17 #include <linux/module.h> 18 #include <linux/of_platform.h> 19 #include <linux/poll.h> 20 #include <linux/slab.h> 21 #include <linux/clk.h> 22 #include <linux/compat.h> 23 #include <linux/highmem.h> 24 25 #include <uapi/misc/xilinx_sdfec.h> 26 27 #define DEV_NAME_LEN 12 28 29 static DEFINE_IDA(dev_nrs); 30 31 /* Xilinx SDFEC Register Map */ 32 /* CODE_WRI_PROTECT Register */ 33 #define XSDFEC_CODE_WR_PROTECT_ADDR (0x4) 34 35 /* ACTIVE Register */ 36 #define XSDFEC_ACTIVE_ADDR (0x8) 37 #define XSDFEC_IS_ACTIVITY_SET (0x1) 38 39 /* AXIS_WIDTH Register */ 40 #define XSDFEC_AXIS_WIDTH_ADDR (0xC) 41 #define XSDFEC_AXIS_DOUT_WORDS_LSB (5) 42 #define XSDFEC_AXIS_DOUT_WIDTH_LSB (3) 43 #define XSDFEC_AXIS_DIN_WORDS_LSB (2) 44 #define XSDFEC_AXIS_DIN_WIDTH_LSB (0) 45 46 /* AXIS_ENABLE Register */ 47 #define XSDFEC_AXIS_ENABLE_ADDR (0x10) 48 #define XSDFEC_AXIS_OUT_ENABLE_MASK (0x38) 49 #define XSDFEC_AXIS_IN_ENABLE_MASK (0x7) 50 #define XSDFEC_AXIS_ENABLE_MASK \ 51 (XSDFEC_AXIS_OUT_ENABLE_MASK | XSDFEC_AXIS_IN_ENABLE_MASK) 52 53 /* FEC_CODE Register */ 54 #define XSDFEC_FEC_CODE_ADDR (0x14) 55 56 /* ORDER Register Map */ 57 #define XSDFEC_ORDER_ADDR (0x18) 58 59 /* Interrupt Status Register */ 60 #define XSDFEC_ISR_ADDR (0x1C) 61 /* Interrupt Status Register Bit Mask */ 62 #define XSDFEC_ISR_MASK (0x3F) 63 64 /* Write Only - Interrupt Enable Register */ 65 #define XSDFEC_IER_ADDR (0x20) 66 /* Write Only - Interrupt Disable Register */ 67 #define XSDFEC_IDR_ADDR (0x24) 68 /* Read Only - Interrupt Mask Register */ 69 #define XSDFEC_IMR_ADDR (0x28) 70 71 /* ECC Interrupt Status Register */ 72 #define XSDFEC_ECC_ISR_ADDR (0x2C) 73 /* Single Bit Errors */ 74 #define XSDFEC_ECC_ISR_SBE_MASK (0x7FF) 75 /* PL Initialize Single Bit Errors */ 76 #define XSDFEC_PL_INIT_ECC_ISR_SBE_MASK (0x3C00000) 77 /* Multi Bit Errors */ 78 #define XSDFEC_ECC_ISR_MBE_MASK (0x3FF800) 79 /* PL Initialize Multi Bit Errors */ 80 #define XSDFEC_PL_INIT_ECC_ISR_MBE_MASK (0x3C000000) 81 /* Multi Bit Error to Event Shift */ 82 #define XSDFEC_ECC_ISR_MBE_TO_EVENT_SHIFT (11) 83 /* PL Initialize Multi Bit Error to Event Shift */ 84 #define XSDFEC_PL_INIT_ECC_ISR_MBE_TO_EVENT_SHIFT (4) 85 /* ECC Interrupt Status Bit Mask */ 86 #define XSDFEC_ECC_ISR_MASK (XSDFEC_ECC_ISR_SBE_MASK | XSDFEC_ECC_ISR_MBE_MASK) 87 /* ECC Interrupt Status PL Initialize Bit Mask */ 88 #define XSDFEC_PL_INIT_ECC_ISR_MASK \ 89 (XSDFEC_PL_INIT_ECC_ISR_SBE_MASK | XSDFEC_PL_INIT_ECC_ISR_MBE_MASK) 90 /* ECC Interrupt Status All Bit Mask */ 91 #define XSDFEC_ALL_ECC_ISR_MASK \ 92 (XSDFEC_ECC_ISR_MASK | XSDFEC_PL_INIT_ECC_ISR_MASK) 93 /* ECC Interrupt Status Single Bit Errors Mask */ 94 #define XSDFEC_ALL_ECC_ISR_SBE_MASK \ 95 (XSDFEC_ECC_ISR_SBE_MASK | XSDFEC_PL_INIT_ECC_ISR_SBE_MASK) 96 /* ECC Interrupt Status Multi Bit Errors Mask */ 97 #define XSDFEC_ALL_ECC_ISR_MBE_MASK \ 98 (XSDFEC_ECC_ISR_MBE_MASK | XSDFEC_PL_INIT_ECC_ISR_MBE_MASK) 99 100 /* Write Only - ECC Interrupt Enable Register */ 101 #define XSDFEC_ECC_IER_ADDR (0x30) 102 /* Write Only - ECC Interrupt Disable Register */ 103 #define XSDFEC_ECC_IDR_ADDR (0x34) 104 /* Read Only - ECC Interrupt Mask Register */ 105 #define XSDFEC_ECC_IMR_ADDR (0x38) 106 107 /* BYPASS Register */ 108 #define XSDFEC_BYPASS_ADDR (0x3C) 109 110 /* Turbo Code Register */ 111 #define XSDFEC_TURBO_ADDR (0x100) 112 #define XSDFEC_TURBO_SCALE_MASK (0xFFF) 113 #define XSDFEC_TURBO_SCALE_BIT_POS (8) 114 #define XSDFEC_TURBO_SCALE_MAX (15) 115 116 /* REG0 Register */ 117 #define XSDFEC_LDPC_CODE_REG0_ADDR_BASE (0x2000) 118 #define XSDFEC_LDPC_CODE_REG0_ADDR_HIGH (0x27F0) 119 #define XSDFEC_REG0_N_MIN (4) 120 #define XSDFEC_REG0_N_MAX (32768) 121 #define XSDFEC_REG0_N_MUL_P (256) 122 #define XSDFEC_REG0_N_LSB (0) 123 #define XSDFEC_REG0_K_MIN (2) 124 #define XSDFEC_REG0_K_MAX (32766) 125 #define XSDFEC_REG0_K_MUL_P (256) 126 #define XSDFEC_REG0_K_LSB (16) 127 128 /* REG1 Register */ 129 #define XSDFEC_LDPC_CODE_REG1_ADDR_BASE (0x2004) 130 #define XSDFEC_LDPC_CODE_REG1_ADDR_HIGH (0x27f4) 131 #define XSDFEC_REG1_PSIZE_MIN (2) 132 #define XSDFEC_REG1_PSIZE_MAX (512) 133 #define XSDFEC_REG1_NO_PACKING_MASK (0x400) 134 #define XSDFEC_REG1_NO_PACKING_LSB (10) 135 #define XSDFEC_REG1_NM_MASK (0xFF800) 136 #define XSDFEC_REG1_NM_LSB (11) 137 #define XSDFEC_REG1_BYPASS_MASK (0x100000) 138 139 /* REG2 Register */ 140 #define XSDFEC_LDPC_CODE_REG2_ADDR_BASE (0x2008) 141 #define XSDFEC_LDPC_CODE_REG2_ADDR_HIGH (0x27f8) 142 #define XSDFEC_REG2_NLAYERS_MIN (1) 143 #define XSDFEC_REG2_NLAYERS_MAX (256) 144 #define XSDFEC_REG2_NNMQC_MASK (0xFFE00) 145 #define XSDFEC_REG2_NMQC_LSB (9) 146 #define XSDFEC_REG2_NORM_TYPE_MASK (0x100000) 147 #define XSDFEC_REG2_NORM_TYPE_LSB (20) 148 #define XSDFEC_REG2_SPECIAL_QC_MASK (0x200000) 149 #define XSDFEC_REG2_SPEICAL_QC_LSB (21) 150 #define XSDFEC_REG2_NO_FINAL_PARITY_MASK (0x400000) 151 #define XSDFEC_REG2_NO_FINAL_PARITY_LSB (22) 152 #define XSDFEC_REG2_MAX_SCHEDULE_MASK (0x1800000) 153 #define XSDFEC_REG2_MAX_SCHEDULE_LSB (23) 154 155 /* REG3 Register */ 156 #define XSDFEC_LDPC_CODE_REG3_ADDR_BASE (0x200C) 157 #define XSDFEC_LDPC_CODE_REG3_ADDR_HIGH (0x27FC) 158 #define XSDFEC_REG3_LA_OFF_LSB (8) 159 #define XSDFEC_REG3_QC_OFF_LSB (16) 160 161 #define XSDFEC_LDPC_REG_JUMP (0x10) 162 #define XSDFEC_REG_WIDTH_JUMP (4) 163 164 /* The maximum number of pinned pages */ 165 #define MAX_NUM_PAGES ((XSDFEC_QC_TABLE_DEPTH / PAGE_SIZE) + 1) 166 167 /** 168 * struct xsdfec_clks - For managing SD-FEC clocks 169 * @core_clk: Main processing clock for core 170 * @axi_clk: AXI4-Lite memory-mapped clock 171 * @din_words_clk: DIN Words AXI4-Stream Slave clock 172 * @din_clk: DIN AXI4-Stream Slave clock 173 * @dout_clk: DOUT Words AXI4-Stream Slave clock 174 * @dout_words_clk: DOUT AXI4-Stream Slave clock 175 * @ctrl_clk: Control AXI4-Stream Slave clock 176 * @status_clk: Status AXI4-Stream Slave clock 177 */ 178 struct xsdfec_clks { 179 struct clk *core_clk; 180 struct clk *axi_clk; 181 struct clk *din_words_clk; 182 struct clk *din_clk; 183 struct clk *dout_clk; 184 struct clk *dout_words_clk; 185 struct clk *ctrl_clk; 186 struct clk *status_clk; 187 }; 188 189 /** 190 * struct xsdfec_dev - Driver data for SDFEC 191 * @miscdev: Misc device handle 192 * @clks: Clocks managed by the SDFEC driver 193 * @waitq: Driver wait queue 194 * @config: Configuration of the SDFEC device 195 * @dev_name: Device name 196 * @flags: spinlock flags 197 * @regs: device physical base address 198 * @dev: pointer to device struct 199 * @state: State of the SDFEC device 200 * @error_data_lock: Error counter and states spinlock 201 * @dev_id: Device ID 202 * @isr_err_count: Count of ISR errors 203 * @cecc_count: Count of Correctable ECC errors (SBE) 204 * @uecc_count: Count of Uncorrectable ECC errors (MBE) 205 * @irq: IRQ number 206 * @state_updated: indicates State updated by interrupt handler 207 * @stats_updated: indicates Stats updated by interrupt handler 208 * @intr_enabled: indicates IRQ enabled 209 * 210 * This structure contains necessary state for SDFEC driver to operate 211 */ 212 struct xsdfec_dev { 213 struct miscdevice miscdev; 214 struct xsdfec_clks clks; 215 wait_queue_head_t waitq; 216 struct xsdfec_config config; 217 char dev_name[DEV_NAME_LEN]; 218 unsigned long flags; 219 void __iomem *regs; 220 struct device *dev; 221 enum xsdfec_state state; 222 /* Spinlock to protect state_updated and stats_updated */ 223 spinlock_t error_data_lock; 224 int dev_id; 225 u32 isr_err_count; 226 u32 cecc_count; 227 u32 uecc_count; 228 int irq; 229 bool state_updated; 230 bool stats_updated; 231 bool intr_enabled; 232 }; 233 234 static inline void xsdfec_regwrite(struct xsdfec_dev *xsdfec, u32 addr, 235 u32 value) 236 { 237 dev_dbg(xsdfec->dev, "Writing 0x%x to offset 0x%x", value, addr); 238 iowrite32(value, xsdfec->regs + addr); 239 } 240 241 static inline u32 xsdfec_regread(struct xsdfec_dev *xsdfec, u32 addr) 242 { 243 u32 rval; 244 245 rval = ioread32(xsdfec->regs + addr); 246 dev_dbg(xsdfec->dev, "Read value = 0x%x from offset 0x%x", rval, addr); 247 return rval; 248 } 249 250 static void update_bool_config_from_reg(struct xsdfec_dev *xsdfec, 251 u32 reg_offset, u32 bit_num, 252 char *config_value) 253 { 254 u32 reg_val; 255 u32 bit_mask = 1 << bit_num; 256 257 reg_val = xsdfec_regread(xsdfec, reg_offset); 258 *config_value = (reg_val & bit_mask) > 0; 259 } 260 261 static void update_config_from_hw(struct xsdfec_dev *xsdfec) 262 { 263 u32 reg_value; 264 bool sdfec_started; 265 266 /* Update the Order */ 267 reg_value = xsdfec_regread(xsdfec, XSDFEC_ORDER_ADDR); 268 xsdfec->config.order = reg_value; 269 270 update_bool_config_from_reg(xsdfec, XSDFEC_BYPASS_ADDR, 271 0, /* Bit Number, maybe change to mask */ 272 &xsdfec->config.bypass); 273 274 update_bool_config_from_reg(xsdfec, XSDFEC_CODE_WR_PROTECT_ADDR, 275 0, /* Bit Number */ 276 &xsdfec->config.code_wr_protect); 277 278 reg_value = xsdfec_regread(xsdfec, XSDFEC_IMR_ADDR); 279 xsdfec->config.irq.enable_isr = (reg_value & XSDFEC_ISR_MASK) > 0; 280 281 reg_value = xsdfec_regread(xsdfec, XSDFEC_ECC_IMR_ADDR); 282 xsdfec->config.irq.enable_ecc_isr = 283 (reg_value & XSDFEC_ECC_ISR_MASK) > 0; 284 285 reg_value = xsdfec_regread(xsdfec, XSDFEC_AXIS_ENABLE_ADDR); 286 sdfec_started = (reg_value & XSDFEC_AXIS_IN_ENABLE_MASK) > 0; 287 if (sdfec_started) 288 xsdfec->state = XSDFEC_STARTED; 289 else 290 xsdfec->state = XSDFEC_STOPPED; 291 } 292 293 static int xsdfec_get_status(struct xsdfec_dev *xsdfec, void __user *arg) 294 { 295 struct xsdfec_status status; 296 int err; 297 298 memset(&status, 0, sizeof(status)); 299 spin_lock_irqsave(&xsdfec->error_data_lock, xsdfec->flags); 300 status.state = xsdfec->state; 301 xsdfec->state_updated = false; 302 spin_unlock_irqrestore(&xsdfec->error_data_lock, xsdfec->flags); 303 status.activity = (xsdfec_regread(xsdfec, XSDFEC_ACTIVE_ADDR) & 304 XSDFEC_IS_ACTIVITY_SET); 305 306 err = copy_to_user(arg, &status, sizeof(status)); 307 if (err) 308 err = -EFAULT; 309 310 return err; 311 } 312 313 static int xsdfec_get_config(struct xsdfec_dev *xsdfec, void __user *arg) 314 { 315 int err; 316 317 err = copy_to_user(arg, &xsdfec->config, sizeof(xsdfec->config)); 318 if (err) 319 err = -EFAULT; 320 321 return err; 322 } 323 324 static int xsdfec_isr_enable(struct xsdfec_dev *xsdfec, bool enable) 325 { 326 u32 mask_read; 327 328 if (enable) { 329 /* Enable */ 330 xsdfec_regwrite(xsdfec, XSDFEC_IER_ADDR, XSDFEC_ISR_MASK); 331 mask_read = xsdfec_regread(xsdfec, XSDFEC_IMR_ADDR); 332 if (mask_read & XSDFEC_ISR_MASK) { 333 dev_dbg(xsdfec->dev, 334 "SDFEC enabling irq with IER failed"); 335 return -EIO; 336 } 337 } else { 338 /* Disable */ 339 xsdfec_regwrite(xsdfec, XSDFEC_IDR_ADDR, XSDFEC_ISR_MASK); 340 mask_read = xsdfec_regread(xsdfec, XSDFEC_IMR_ADDR); 341 if ((mask_read & XSDFEC_ISR_MASK) != XSDFEC_ISR_MASK) { 342 dev_dbg(xsdfec->dev, 343 "SDFEC disabling irq with IDR failed"); 344 return -EIO; 345 } 346 } 347 return 0; 348 } 349 350 static int xsdfec_ecc_isr_enable(struct xsdfec_dev *xsdfec, bool enable) 351 { 352 u32 mask_read; 353 354 if (enable) { 355 /* Enable */ 356 xsdfec_regwrite(xsdfec, XSDFEC_ECC_IER_ADDR, 357 XSDFEC_ALL_ECC_ISR_MASK); 358 mask_read = xsdfec_regread(xsdfec, XSDFEC_ECC_IMR_ADDR); 359 if (mask_read & XSDFEC_ALL_ECC_ISR_MASK) { 360 dev_dbg(xsdfec->dev, 361 "SDFEC enabling ECC irq with ECC IER failed"); 362 return -EIO; 363 } 364 } else { 365 /* Disable */ 366 xsdfec_regwrite(xsdfec, XSDFEC_ECC_IDR_ADDR, 367 XSDFEC_ALL_ECC_ISR_MASK); 368 mask_read = xsdfec_regread(xsdfec, XSDFEC_ECC_IMR_ADDR); 369 if (!(((mask_read & XSDFEC_ALL_ECC_ISR_MASK) == 370 XSDFEC_ECC_ISR_MASK) || 371 ((mask_read & XSDFEC_ALL_ECC_ISR_MASK) == 372 XSDFEC_PL_INIT_ECC_ISR_MASK))) { 373 dev_dbg(xsdfec->dev, 374 "SDFEC disable ECC irq with ECC IDR failed"); 375 return -EIO; 376 } 377 } 378 return 0; 379 } 380 381 static int xsdfec_set_irq(struct xsdfec_dev *xsdfec, void __user *arg) 382 { 383 struct xsdfec_irq irq; 384 int err; 385 int isr_err; 386 int ecc_err; 387 388 err = copy_from_user(&irq, arg, sizeof(irq)); 389 if (err) 390 return -EFAULT; 391 392 /* Setup tlast related IRQ */ 393 isr_err = xsdfec_isr_enable(xsdfec, irq.enable_isr); 394 if (!isr_err) 395 xsdfec->config.irq.enable_isr = irq.enable_isr; 396 397 /* Setup ECC related IRQ */ 398 ecc_err = xsdfec_ecc_isr_enable(xsdfec, irq.enable_ecc_isr); 399 if (!ecc_err) 400 xsdfec->config.irq.enable_ecc_isr = irq.enable_ecc_isr; 401 402 if (isr_err < 0 || ecc_err < 0) 403 err = -EIO; 404 405 return err; 406 } 407 408 static int xsdfec_set_turbo(struct xsdfec_dev *xsdfec, void __user *arg) 409 { 410 struct xsdfec_turbo turbo; 411 int err; 412 u32 turbo_write; 413 414 err = copy_from_user(&turbo, arg, sizeof(turbo)); 415 if (err) 416 return -EFAULT; 417 418 if (turbo.alg >= XSDFEC_TURBO_ALG_MAX) 419 return -EINVAL; 420 421 if (turbo.scale > XSDFEC_TURBO_SCALE_MAX) 422 return -EINVAL; 423 424 /* Check to see what device tree says about the FEC codes */ 425 if (xsdfec->config.code == XSDFEC_LDPC_CODE) 426 return -EIO; 427 428 turbo_write = ((turbo.scale & XSDFEC_TURBO_SCALE_MASK) 429 << XSDFEC_TURBO_SCALE_BIT_POS) | 430 turbo.alg; 431 xsdfec_regwrite(xsdfec, XSDFEC_TURBO_ADDR, turbo_write); 432 return err; 433 } 434 435 static int xsdfec_get_turbo(struct xsdfec_dev *xsdfec, void __user *arg) 436 { 437 u32 reg_value; 438 struct xsdfec_turbo turbo_params; 439 int err; 440 441 if (xsdfec->config.code == XSDFEC_LDPC_CODE) 442 return -EIO; 443 444 memset(&turbo_params, 0, sizeof(turbo_params)); 445 reg_value = xsdfec_regread(xsdfec, XSDFEC_TURBO_ADDR); 446 447 turbo_params.scale = (reg_value & XSDFEC_TURBO_SCALE_MASK) >> 448 XSDFEC_TURBO_SCALE_BIT_POS; 449 turbo_params.alg = reg_value & 0x1; 450 451 err = copy_to_user(arg, &turbo_params, sizeof(turbo_params)); 452 if (err) 453 err = -EFAULT; 454 455 return err; 456 } 457 458 static int xsdfec_reg0_write(struct xsdfec_dev *xsdfec, u32 n, u32 k, u32 psize, 459 u32 offset) 460 { 461 u32 wdata; 462 463 if (n < XSDFEC_REG0_N_MIN || n > XSDFEC_REG0_N_MAX || psize == 0 || 464 (n > XSDFEC_REG0_N_MUL_P * psize) || n <= k || ((n % psize) != 0)) { 465 dev_dbg(xsdfec->dev, "N value is not in range"); 466 return -EINVAL; 467 } 468 n <<= XSDFEC_REG0_N_LSB; 469 470 if (k < XSDFEC_REG0_K_MIN || k > XSDFEC_REG0_K_MAX || 471 (k > XSDFEC_REG0_K_MUL_P * psize) || ((k % psize) != 0)) { 472 dev_dbg(xsdfec->dev, "K value is not in range"); 473 return -EINVAL; 474 } 475 k = k << XSDFEC_REG0_K_LSB; 476 wdata = k | n; 477 478 if (XSDFEC_LDPC_CODE_REG0_ADDR_BASE + (offset * XSDFEC_LDPC_REG_JUMP) > 479 XSDFEC_LDPC_CODE_REG0_ADDR_HIGH) { 480 dev_dbg(xsdfec->dev, "Writing outside of LDPC reg0 space 0x%x", 481 XSDFEC_LDPC_CODE_REG0_ADDR_BASE + 482 (offset * XSDFEC_LDPC_REG_JUMP)); 483 return -EINVAL; 484 } 485 xsdfec_regwrite(xsdfec, 486 XSDFEC_LDPC_CODE_REG0_ADDR_BASE + 487 (offset * XSDFEC_LDPC_REG_JUMP), 488 wdata); 489 return 0; 490 } 491 492 static int xsdfec_reg1_write(struct xsdfec_dev *xsdfec, u32 psize, 493 u32 no_packing, u32 nm, u32 offset) 494 { 495 u32 wdata; 496 497 if (psize < XSDFEC_REG1_PSIZE_MIN || psize > XSDFEC_REG1_PSIZE_MAX) { 498 dev_dbg(xsdfec->dev, "Psize is not in range"); 499 return -EINVAL; 500 } 501 502 if (no_packing != 0 && no_packing != 1) 503 dev_dbg(xsdfec->dev, "No-packing bit register invalid"); 504 no_packing = ((no_packing << XSDFEC_REG1_NO_PACKING_LSB) & 505 XSDFEC_REG1_NO_PACKING_MASK); 506 507 if (nm & ~(XSDFEC_REG1_NM_MASK >> XSDFEC_REG1_NM_LSB)) 508 dev_dbg(xsdfec->dev, "NM is beyond 10 bits"); 509 nm = (nm << XSDFEC_REG1_NM_LSB) & XSDFEC_REG1_NM_MASK; 510 511 wdata = nm | no_packing | psize; 512 if (XSDFEC_LDPC_CODE_REG1_ADDR_BASE + (offset * XSDFEC_LDPC_REG_JUMP) > 513 XSDFEC_LDPC_CODE_REG1_ADDR_HIGH) { 514 dev_dbg(xsdfec->dev, "Writing outside of LDPC reg1 space 0x%x", 515 XSDFEC_LDPC_CODE_REG1_ADDR_BASE + 516 (offset * XSDFEC_LDPC_REG_JUMP)); 517 return -EINVAL; 518 } 519 xsdfec_regwrite(xsdfec, 520 XSDFEC_LDPC_CODE_REG1_ADDR_BASE + 521 (offset * XSDFEC_LDPC_REG_JUMP), 522 wdata); 523 return 0; 524 } 525 526 static int xsdfec_reg2_write(struct xsdfec_dev *xsdfec, u32 nlayers, u32 nmqc, 527 u32 norm_type, u32 special_qc, u32 no_final_parity, 528 u32 max_schedule, u32 offset) 529 { 530 u32 wdata; 531 532 if (nlayers < XSDFEC_REG2_NLAYERS_MIN || 533 nlayers > XSDFEC_REG2_NLAYERS_MAX) { 534 dev_dbg(xsdfec->dev, "Nlayers is not in range"); 535 return -EINVAL; 536 } 537 538 if (nmqc & ~(XSDFEC_REG2_NNMQC_MASK >> XSDFEC_REG2_NMQC_LSB)) 539 dev_dbg(xsdfec->dev, "NMQC exceeds 11 bits"); 540 nmqc = (nmqc << XSDFEC_REG2_NMQC_LSB) & XSDFEC_REG2_NNMQC_MASK; 541 542 if (norm_type > 1) 543 dev_dbg(xsdfec->dev, "Norm type is invalid"); 544 norm_type = ((norm_type << XSDFEC_REG2_NORM_TYPE_LSB) & 545 XSDFEC_REG2_NORM_TYPE_MASK); 546 if (special_qc > 1) 547 dev_dbg(xsdfec->dev, "Special QC in invalid"); 548 special_qc = ((special_qc << XSDFEC_REG2_SPEICAL_QC_LSB) & 549 XSDFEC_REG2_SPECIAL_QC_MASK); 550 551 if (no_final_parity > 1) 552 dev_dbg(xsdfec->dev, "No final parity check invalid"); 553 no_final_parity = 554 ((no_final_parity << XSDFEC_REG2_NO_FINAL_PARITY_LSB) & 555 XSDFEC_REG2_NO_FINAL_PARITY_MASK); 556 if (max_schedule & 557 ~(XSDFEC_REG2_MAX_SCHEDULE_MASK >> XSDFEC_REG2_MAX_SCHEDULE_LSB)) 558 dev_dbg(xsdfec->dev, "Max Schdule exceeds 2 bits"); 559 max_schedule = ((max_schedule << XSDFEC_REG2_MAX_SCHEDULE_LSB) & 560 XSDFEC_REG2_MAX_SCHEDULE_MASK); 561 562 wdata = (max_schedule | no_final_parity | special_qc | norm_type | 563 nmqc | nlayers); 564 565 if (XSDFEC_LDPC_CODE_REG2_ADDR_BASE + (offset * XSDFEC_LDPC_REG_JUMP) > 566 XSDFEC_LDPC_CODE_REG2_ADDR_HIGH) { 567 dev_dbg(xsdfec->dev, "Writing outside of LDPC reg2 space 0x%x", 568 XSDFEC_LDPC_CODE_REG2_ADDR_BASE + 569 (offset * XSDFEC_LDPC_REG_JUMP)); 570 return -EINVAL; 571 } 572 xsdfec_regwrite(xsdfec, 573 XSDFEC_LDPC_CODE_REG2_ADDR_BASE + 574 (offset * XSDFEC_LDPC_REG_JUMP), 575 wdata); 576 return 0; 577 } 578 579 static int xsdfec_reg3_write(struct xsdfec_dev *xsdfec, u8 sc_off, u8 la_off, 580 u16 qc_off, u32 offset) 581 { 582 u32 wdata; 583 584 wdata = ((qc_off << XSDFEC_REG3_QC_OFF_LSB) | 585 (la_off << XSDFEC_REG3_LA_OFF_LSB) | sc_off); 586 if (XSDFEC_LDPC_CODE_REG3_ADDR_BASE + (offset * XSDFEC_LDPC_REG_JUMP) > 587 XSDFEC_LDPC_CODE_REG3_ADDR_HIGH) { 588 dev_dbg(xsdfec->dev, "Writing outside of LDPC reg3 space 0x%x", 589 XSDFEC_LDPC_CODE_REG3_ADDR_BASE + 590 (offset * XSDFEC_LDPC_REG_JUMP)); 591 return -EINVAL; 592 } 593 xsdfec_regwrite(xsdfec, 594 XSDFEC_LDPC_CODE_REG3_ADDR_BASE + 595 (offset * XSDFEC_LDPC_REG_JUMP), 596 wdata); 597 return 0; 598 } 599 600 static int xsdfec_table_write(struct xsdfec_dev *xsdfec, u32 offset, 601 u32 *src_ptr, u32 len, const u32 base_addr, 602 const u32 depth) 603 { 604 u32 reg = 0; 605 u32 res; 606 u32 n, i; 607 u32 *addr = NULL; 608 struct page *page[MAX_NUM_PAGES]; 609 610 /* 611 * Writes that go beyond the length of 612 * Shared Scale(SC) table should fail 613 */ 614 if ((XSDFEC_REG_WIDTH_JUMP * (offset + len)) > depth) { 615 dev_dbg(xsdfec->dev, "Write exceeds SC table length"); 616 return -EINVAL; 617 } 618 619 n = (len * XSDFEC_REG_WIDTH_JUMP) / PAGE_SIZE; 620 if ((len * XSDFEC_REG_WIDTH_JUMP) % PAGE_SIZE) 621 n += 1; 622 623 res = get_user_pages_fast((unsigned long)src_ptr, n, 0, page); 624 if (res < n) { 625 for (i = 0; i < res; i++) 626 put_page(page[i]); 627 return -EINVAL; 628 } 629 630 for (i = 0; i < n; i++) { 631 addr = kmap(page[i]); 632 do { 633 xsdfec_regwrite(xsdfec, 634 base_addr + ((offset + reg) * 635 XSDFEC_REG_WIDTH_JUMP), 636 addr[reg]); 637 reg++; 638 } while ((reg < len) && 639 ((reg * XSDFEC_REG_WIDTH_JUMP) % PAGE_SIZE)); 640 put_page(page[i]); 641 } 642 return reg; 643 } 644 645 static int xsdfec_add_ldpc(struct xsdfec_dev *xsdfec, void __user *arg) 646 { 647 struct xsdfec_ldpc_params *ldpc; 648 int ret, n; 649 650 ldpc = kzalloc(sizeof(*ldpc), GFP_KERNEL); 651 if (!ldpc) 652 return -ENOMEM; 653 654 if (copy_from_user(ldpc, arg, sizeof(*ldpc))) { 655 ret = -EFAULT; 656 goto err_out; 657 } 658 659 if (xsdfec->config.code == XSDFEC_TURBO_CODE) { 660 ret = -EIO; 661 goto err_out; 662 } 663 664 /* Verify Device has not started */ 665 if (xsdfec->state == XSDFEC_STARTED) { 666 ret = -EIO; 667 goto err_out; 668 } 669 670 if (xsdfec->config.code_wr_protect) { 671 ret = -EIO; 672 goto err_out; 673 } 674 675 /* Write Reg 0 */ 676 ret = xsdfec_reg0_write(xsdfec, ldpc->n, ldpc->k, ldpc->psize, 677 ldpc->code_id); 678 if (ret) 679 goto err_out; 680 681 /* Write Reg 1 */ 682 ret = xsdfec_reg1_write(xsdfec, ldpc->psize, ldpc->no_packing, ldpc->nm, 683 ldpc->code_id); 684 if (ret) 685 goto err_out; 686 687 /* Write Reg 2 */ 688 ret = xsdfec_reg2_write(xsdfec, ldpc->nlayers, ldpc->nmqc, 689 ldpc->norm_type, ldpc->special_qc, 690 ldpc->no_final_parity, ldpc->max_schedule, 691 ldpc->code_id); 692 if (ret) 693 goto err_out; 694 695 /* Write Reg 3 */ 696 ret = xsdfec_reg3_write(xsdfec, ldpc->sc_off, ldpc->la_off, 697 ldpc->qc_off, ldpc->code_id); 698 if (ret) 699 goto err_out; 700 701 /* Write Shared Codes */ 702 n = ldpc->nlayers / 4; 703 if (ldpc->nlayers % 4) 704 n++; 705 706 ret = xsdfec_table_write(xsdfec, ldpc->sc_off, ldpc->sc_table, n, 707 XSDFEC_LDPC_SC_TABLE_ADDR_BASE, 708 XSDFEC_SC_TABLE_DEPTH); 709 if (ret < 0) 710 goto err_out; 711 712 ret = xsdfec_table_write(xsdfec, 4 * ldpc->la_off, ldpc->la_table, 713 ldpc->nlayers, XSDFEC_LDPC_LA_TABLE_ADDR_BASE, 714 XSDFEC_LA_TABLE_DEPTH); 715 if (ret < 0) 716 goto err_out; 717 718 ret = xsdfec_table_write(xsdfec, 4 * ldpc->qc_off, ldpc->qc_table, 719 ldpc->nqc, XSDFEC_LDPC_QC_TABLE_ADDR_BASE, 720 XSDFEC_QC_TABLE_DEPTH); 721 if (ret > 0) 722 ret = 0; 723 err_out: 724 kfree(ldpc); 725 return ret; 726 } 727 728 static int xsdfec_set_order(struct xsdfec_dev *xsdfec, void __user *arg) 729 { 730 bool order_invalid; 731 enum xsdfec_order order; 732 int err; 733 734 err = get_user(order, (enum xsdfec_order *)arg); 735 if (err) 736 return -EFAULT; 737 738 order_invalid = (order != XSDFEC_MAINTAIN_ORDER) && 739 (order != XSDFEC_OUT_OF_ORDER); 740 if (order_invalid) 741 return -EINVAL; 742 743 /* Verify Device has not started */ 744 if (xsdfec->state == XSDFEC_STARTED) 745 return -EIO; 746 747 xsdfec_regwrite(xsdfec, XSDFEC_ORDER_ADDR, order); 748 749 xsdfec->config.order = order; 750 751 return 0; 752 } 753 754 static int xsdfec_set_bypass(struct xsdfec_dev *xsdfec, bool __user *arg) 755 { 756 bool bypass; 757 int err; 758 759 err = get_user(bypass, arg); 760 if (err) 761 return -EFAULT; 762 763 /* Verify Device has not started */ 764 if (xsdfec->state == XSDFEC_STARTED) 765 return -EIO; 766 767 if (bypass) 768 xsdfec_regwrite(xsdfec, XSDFEC_BYPASS_ADDR, 1); 769 else 770 xsdfec_regwrite(xsdfec, XSDFEC_BYPASS_ADDR, 0); 771 772 xsdfec->config.bypass = bypass; 773 774 return 0; 775 } 776 777 static int xsdfec_is_active(struct xsdfec_dev *xsdfec, bool __user *arg) 778 { 779 u32 reg_value; 780 bool is_active; 781 int err; 782 783 reg_value = xsdfec_regread(xsdfec, XSDFEC_ACTIVE_ADDR); 784 /* using a double ! operator instead of casting */ 785 is_active = !!(reg_value & XSDFEC_IS_ACTIVITY_SET); 786 err = put_user(is_active, arg); 787 if (err) 788 return -EFAULT; 789 790 return err; 791 } 792 793 static u32 794 xsdfec_translate_axis_width_cfg_val(enum xsdfec_axis_width axis_width_cfg) 795 { 796 u32 axis_width_field = 0; 797 798 switch (axis_width_cfg) { 799 case XSDFEC_1x128b: 800 axis_width_field = 0; 801 break; 802 case XSDFEC_2x128b: 803 axis_width_field = 1; 804 break; 805 case XSDFEC_4x128b: 806 axis_width_field = 2; 807 break; 808 } 809 810 return axis_width_field; 811 } 812 813 static u32 xsdfec_translate_axis_words_cfg_val(enum xsdfec_axis_word_include 814 axis_word_inc_cfg) 815 { 816 u32 axis_words_field = 0; 817 818 if (axis_word_inc_cfg == XSDFEC_FIXED_VALUE || 819 axis_word_inc_cfg == XSDFEC_IN_BLOCK) 820 axis_words_field = 0; 821 else if (axis_word_inc_cfg == XSDFEC_PER_AXI_TRANSACTION) 822 axis_words_field = 1; 823 824 return axis_words_field; 825 } 826 827 static int xsdfec_cfg_axi_streams(struct xsdfec_dev *xsdfec) 828 { 829 u32 reg_value; 830 u32 dout_words_field; 831 u32 dout_width_field; 832 u32 din_words_field; 833 u32 din_width_field; 834 struct xsdfec_config *config = &xsdfec->config; 835 836 /* translate config info to register values */ 837 dout_words_field = 838 xsdfec_translate_axis_words_cfg_val(config->dout_word_include); 839 dout_width_field = 840 xsdfec_translate_axis_width_cfg_val(config->dout_width); 841 din_words_field = 842 xsdfec_translate_axis_words_cfg_val(config->din_word_include); 843 din_width_field = 844 xsdfec_translate_axis_width_cfg_val(config->din_width); 845 846 reg_value = dout_words_field << XSDFEC_AXIS_DOUT_WORDS_LSB; 847 reg_value |= dout_width_field << XSDFEC_AXIS_DOUT_WIDTH_LSB; 848 reg_value |= din_words_field << XSDFEC_AXIS_DIN_WORDS_LSB; 849 reg_value |= din_width_field << XSDFEC_AXIS_DIN_WIDTH_LSB; 850 851 xsdfec_regwrite(xsdfec, XSDFEC_AXIS_WIDTH_ADDR, reg_value); 852 853 return 0; 854 } 855 856 static int xsdfec_dev_open(struct inode *iptr, struct file *fptr) 857 { 858 return 0; 859 } 860 861 static int xsdfec_dev_release(struct inode *iptr, struct file *fptr) 862 { 863 return 0; 864 } 865 866 static int xsdfec_start(struct xsdfec_dev *xsdfec) 867 { 868 u32 regread; 869 870 regread = xsdfec_regread(xsdfec, XSDFEC_FEC_CODE_ADDR); 871 regread &= 0x1; 872 if (regread != xsdfec->config.code) { 873 dev_dbg(xsdfec->dev, 874 "%s SDFEC HW code does not match driver code, reg %d, code %d", 875 __func__, regread, xsdfec->config.code); 876 return -EINVAL; 877 } 878 879 /* Set AXIS enable */ 880 xsdfec_regwrite(xsdfec, XSDFEC_AXIS_ENABLE_ADDR, 881 XSDFEC_AXIS_ENABLE_MASK); 882 /* Done */ 883 xsdfec->state = XSDFEC_STARTED; 884 return 0; 885 } 886 887 static int xsdfec_stop(struct xsdfec_dev *xsdfec) 888 { 889 u32 regread; 890 891 if (xsdfec->state != XSDFEC_STARTED) 892 dev_dbg(xsdfec->dev, "Device not started correctly"); 893 /* Disable AXIS_ENABLE Input interfaces only */ 894 regread = xsdfec_regread(xsdfec, XSDFEC_AXIS_ENABLE_ADDR); 895 regread &= (~XSDFEC_AXIS_IN_ENABLE_MASK); 896 xsdfec_regwrite(xsdfec, XSDFEC_AXIS_ENABLE_ADDR, regread); 897 /* Stop */ 898 xsdfec->state = XSDFEC_STOPPED; 899 return 0; 900 } 901 902 static int xsdfec_clear_stats(struct xsdfec_dev *xsdfec) 903 { 904 spin_lock_irqsave(&xsdfec->error_data_lock, xsdfec->flags); 905 xsdfec->isr_err_count = 0; 906 xsdfec->uecc_count = 0; 907 xsdfec->cecc_count = 0; 908 spin_unlock_irqrestore(&xsdfec->error_data_lock, xsdfec->flags); 909 910 return 0; 911 } 912 913 static int xsdfec_get_stats(struct xsdfec_dev *xsdfec, void __user *arg) 914 { 915 int err; 916 struct xsdfec_stats user_stats; 917 918 spin_lock_irqsave(&xsdfec->error_data_lock, xsdfec->flags); 919 user_stats.isr_err_count = xsdfec->isr_err_count; 920 user_stats.cecc_count = xsdfec->cecc_count; 921 user_stats.uecc_count = xsdfec->uecc_count; 922 xsdfec->stats_updated = false; 923 spin_unlock_irqrestore(&xsdfec->error_data_lock, xsdfec->flags); 924 925 err = copy_to_user(arg, &user_stats, sizeof(user_stats)); 926 if (err) 927 err = -EFAULT; 928 929 return err; 930 } 931 932 static int xsdfec_set_default_config(struct xsdfec_dev *xsdfec) 933 { 934 /* Ensure registers are aligned with core configuration */ 935 xsdfec_regwrite(xsdfec, XSDFEC_FEC_CODE_ADDR, xsdfec->config.code); 936 xsdfec_cfg_axi_streams(xsdfec); 937 update_config_from_hw(xsdfec); 938 939 return 0; 940 } 941 942 static long xsdfec_dev_ioctl(struct file *fptr, unsigned int cmd, 943 unsigned long data) 944 { 945 struct xsdfec_dev *xsdfec; 946 void __user *arg = NULL; 947 int rval = -EINVAL; 948 949 xsdfec = container_of(fptr->private_data, struct xsdfec_dev, miscdev); 950 951 /* In failed state allow only reset and get status IOCTLs */ 952 if (xsdfec->state == XSDFEC_NEEDS_RESET && 953 (cmd != XSDFEC_SET_DEFAULT_CONFIG && cmd != XSDFEC_GET_STATUS && 954 cmd != XSDFEC_GET_STATS && cmd != XSDFEC_CLEAR_STATS)) { 955 return -EPERM; 956 } 957 958 if (_IOC_TYPE(cmd) != XSDFEC_MAGIC) 959 return -ENOTTY; 960 961 /* check if ioctl argument is present and valid */ 962 if (_IOC_DIR(cmd) != _IOC_NONE) { 963 arg = (void __user *)data; 964 if (!arg) 965 return rval; 966 } 967 968 switch (cmd) { 969 case XSDFEC_START_DEV: 970 rval = xsdfec_start(xsdfec); 971 break; 972 case XSDFEC_STOP_DEV: 973 rval = xsdfec_stop(xsdfec); 974 break; 975 case XSDFEC_CLEAR_STATS: 976 rval = xsdfec_clear_stats(xsdfec); 977 break; 978 case XSDFEC_GET_STATS: 979 rval = xsdfec_get_stats(xsdfec, arg); 980 break; 981 case XSDFEC_GET_STATUS: 982 rval = xsdfec_get_status(xsdfec, arg); 983 break; 984 case XSDFEC_GET_CONFIG: 985 rval = xsdfec_get_config(xsdfec, arg); 986 break; 987 case XSDFEC_SET_DEFAULT_CONFIG: 988 rval = xsdfec_set_default_config(xsdfec); 989 break; 990 case XSDFEC_SET_IRQ: 991 rval = xsdfec_set_irq(xsdfec, arg); 992 break; 993 case XSDFEC_SET_TURBO: 994 rval = xsdfec_set_turbo(xsdfec, arg); 995 break; 996 case XSDFEC_GET_TURBO: 997 rval = xsdfec_get_turbo(xsdfec, arg); 998 break; 999 case XSDFEC_ADD_LDPC_CODE_PARAMS: 1000 rval = xsdfec_add_ldpc(xsdfec, arg); 1001 break; 1002 case XSDFEC_SET_ORDER: 1003 rval = xsdfec_set_order(xsdfec, arg); 1004 break; 1005 case XSDFEC_SET_BYPASS: 1006 rval = xsdfec_set_bypass(xsdfec, arg); 1007 break; 1008 case XSDFEC_IS_ACTIVE: 1009 rval = xsdfec_is_active(xsdfec, (bool __user *)arg); 1010 break; 1011 default: 1012 /* Should not get here */ 1013 break; 1014 } 1015 return rval; 1016 } 1017 1018 #ifdef CONFIG_COMPAT 1019 static long xsdfec_dev_compat_ioctl(struct file *file, unsigned int cmd, 1020 unsigned long data) 1021 { 1022 return xsdfec_dev_ioctl(file, cmd, (unsigned long)compat_ptr(data)); 1023 } 1024 #endif 1025 1026 static unsigned int xsdfec_poll(struct file *file, poll_table *wait) 1027 { 1028 unsigned int mask = 0; 1029 struct xsdfec_dev *xsdfec; 1030 1031 xsdfec = container_of(file->private_data, struct xsdfec_dev, miscdev); 1032 1033 if (!xsdfec) 1034 return POLLNVAL | POLLHUP; 1035 1036 poll_wait(file, &xsdfec->waitq, wait); 1037 1038 /* XSDFEC ISR detected an error */ 1039 spin_lock_irqsave(&xsdfec->error_data_lock, xsdfec->flags); 1040 if (xsdfec->state_updated) 1041 mask |= POLLIN | POLLPRI; 1042 1043 if (xsdfec->stats_updated) 1044 mask |= POLLIN | POLLRDNORM; 1045 spin_unlock_irqrestore(&xsdfec->error_data_lock, xsdfec->flags); 1046 1047 return mask; 1048 } 1049 1050 static const struct file_operations xsdfec_fops = { 1051 .owner = THIS_MODULE, 1052 .open = xsdfec_dev_open, 1053 .release = xsdfec_dev_release, 1054 .unlocked_ioctl = xsdfec_dev_ioctl, 1055 .poll = xsdfec_poll, 1056 #ifdef CONFIG_COMPAT 1057 .compat_ioctl = xsdfec_dev_compat_ioctl, 1058 #endif 1059 }; 1060 1061 static int xsdfec_parse_of(struct xsdfec_dev *xsdfec) 1062 { 1063 struct device *dev = xsdfec->dev; 1064 struct device_node *node = dev->of_node; 1065 int rval; 1066 const char *fec_code; 1067 u32 din_width; 1068 u32 din_word_include; 1069 u32 dout_width; 1070 u32 dout_word_include; 1071 1072 rval = of_property_read_string(node, "xlnx,sdfec-code", &fec_code); 1073 if (rval < 0) 1074 return rval; 1075 1076 if (!strcasecmp(fec_code, "ldpc")) 1077 xsdfec->config.code = XSDFEC_LDPC_CODE; 1078 else if (!strcasecmp(fec_code, "turbo")) 1079 xsdfec->config.code = XSDFEC_TURBO_CODE; 1080 else 1081 return -EINVAL; 1082 1083 rval = of_property_read_u32(node, "xlnx,sdfec-din-words", 1084 &din_word_include); 1085 if (rval < 0) 1086 return rval; 1087 1088 if (din_word_include < XSDFEC_AXIS_WORDS_INCLUDE_MAX) 1089 xsdfec->config.din_word_include = din_word_include; 1090 else 1091 return -EINVAL; 1092 1093 rval = of_property_read_u32(node, "xlnx,sdfec-din-width", &din_width); 1094 if (rval < 0) 1095 return rval; 1096 1097 switch (din_width) { 1098 /* Fall through and set for valid values */ 1099 case XSDFEC_1x128b: 1100 case XSDFEC_2x128b: 1101 case XSDFEC_4x128b: 1102 xsdfec->config.din_width = din_width; 1103 break; 1104 default: 1105 return -EINVAL; 1106 } 1107 1108 rval = of_property_read_u32(node, "xlnx,sdfec-dout-words", 1109 &dout_word_include); 1110 if (rval < 0) 1111 return rval; 1112 1113 if (dout_word_include < XSDFEC_AXIS_WORDS_INCLUDE_MAX) 1114 xsdfec->config.dout_word_include = dout_word_include; 1115 else 1116 return -EINVAL; 1117 1118 rval = of_property_read_u32(node, "xlnx,sdfec-dout-width", &dout_width); 1119 if (rval < 0) 1120 return rval; 1121 1122 switch (dout_width) { 1123 /* Fall through and set for valid values */ 1124 case XSDFEC_1x128b: 1125 case XSDFEC_2x128b: 1126 case XSDFEC_4x128b: 1127 xsdfec->config.dout_width = dout_width; 1128 break; 1129 default: 1130 return -EINVAL; 1131 } 1132 1133 /* Write LDPC to CODE Register */ 1134 xsdfec_regwrite(xsdfec, XSDFEC_FEC_CODE_ADDR, xsdfec->config.code); 1135 1136 xsdfec_cfg_axi_streams(xsdfec); 1137 1138 return 0; 1139 } 1140 1141 static irqreturn_t xsdfec_irq_thread(int irq, void *dev_id) 1142 { 1143 struct xsdfec_dev *xsdfec = dev_id; 1144 irqreturn_t ret = IRQ_HANDLED; 1145 u32 ecc_err; 1146 u32 isr_err; 1147 u32 uecc_count; 1148 u32 cecc_count; 1149 u32 isr_err_count; 1150 u32 aecc_count; 1151 u32 tmp; 1152 1153 WARN_ON(xsdfec->irq != irq); 1154 1155 /* Mask Interrupts */ 1156 xsdfec_isr_enable(xsdfec, false); 1157 xsdfec_ecc_isr_enable(xsdfec, false); 1158 /* Read ISR */ 1159 ecc_err = xsdfec_regread(xsdfec, XSDFEC_ECC_ISR_ADDR); 1160 isr_err = xsdfec_regread(xsdfec, XSDFEC_ISR_ADDR); 1161 /* Clear the interrupts */ 1162 xsdfec_regwrite(xsdfec, XSDFEC_ECC_ISR_ADDR, ecc_err); 1163 xsdfec_regwrite(xsdfec, XSDFEC_ISR_ADDR, isr_err); 1164 1165 tmp = ecc_err & XSDFEC_ALL_ECC_ISR_MBE_MASK; 1166 /* Count uncorrectable 2-bit errors */ 1167 uecc_count = hweight32(tmp); 1168 /* Count all ECC errors */ 1169 aecc_count = hweight32(ecc_err); 1170 /* Number of correctable 1-bit ECC error */ 1171 cecc_count = aecc_count - 2 * uecc_count; 1172 /* Count ISR errors */ 1173 isr_err_count = hweight32(isr_err); 1174 dev_dbg(xsdfec->dev, "tmp=%x, uecc=%x, aecc=%x, cecc=%x, isr=%x", tmp, 1175 uecc_count, aecc_count, cecc_count, isr_err_count); 1176 dev_dbg(xsdfec->dev, "uecc=%x, cecc=%x, isr=%x", xsdfec->uecc_count, 1177 xsdfec->cecc_count, xsdfec->isr_err_count); 1178 1179 spin_lock_irqsave(&xsdfec->error_data_lock, xsdfec->flags); 1180 /* Add new errors to a 2-bits counter */ 1181 if (uecc_count) 1182 xsdfec->uecc_count += uecc_count; 1183 /* Add new errors to a 1-bits counter */ 1184 if (cecc_count) 1185 xsdfec->cecc_count += cecc_count; 1186 /* Add new errors to a ISR counter */ 1187 if (isr_err_count) 1188 xsdfec->isr_err_count += isr_err_count; 1189 1190 /* Update state/stats flag */ 1191 if (uecc_count) { 1192 if (ecc_err & XSDFEC_ECC_ISR_MBE_MASK) 1193 xsdfec->state = XSDFEC_NEEDS_RESET; 1194 else if (ecc_err & XSDFEC_PL_INIT_ECC_ISR_MBE_MASK) 1195 xsdfec->state = XSDFEC_PL_RECONFIGURE; 1196 xsdfec->stats_updated = true; 1197 xsdfec->state_updated = true; 1198 } 1199 1200 if (cecc_count) 1201 xsdfec->stats_updated = true; 1202 1203 if (isr_err_count) { 1204 xsdfec->state = XSDFEC_NEEDS_RESET; 1205 xsdfec->stats_updated = true; 1206 xsdfec->state_updated = true; 1207 } 1208 1209 spin_unlock_irqrestore(&xsdfec->error_data_lock, xsdfec->flags); 1210 dev_dbg(xsdfec->dev, "state=%x, stats=%x", xsdfec->state_updated, 1211 xsdfec->stats_updated); 1212 1213 /* Enable another polling */ 1214 if (xsdfec->state_updated || xsdfec->stats_updated) 1215 wake_up_interruptible(&xsdfec->waitq); 1216 else 1217 ret = IRQ_NONE; 1218 1219 /* Unmask Interrupts */ 1220 xsdfec_isr_enable(xsdfec, true); 1221 xsdfec_ecc_isr_enable(xsdfec, true); 1222 1223 return ret; 1224 } 1225 1226 static int xsdfec_clk_init(struct platform_device *pdev, 1227 struct xsdfec_clks *clks) 1228 { 1229 int err; 1230 1231 clks->core_clk = devm_clk_get(&pdev->dev, "core_clk"); 1232 if (IS_ERR(clks->core_clk)) { 1233 dev_err(&pdev->dev, "failed to get core_clk"); 1234 return PTR_ERR(clks->core_clk); 1235 } 1236 1237 clks->axi_clk = devm_clk_get(&pdev->dev, "s_axi_aclk"); 1238 if (IS_ERR(clks->axi_clk)) { 1239 dev_err(&pdev->dev, "failed to get axi_clk"); 1240 return PTR_ERR(clks->axi_clk); 1241 } 1242 1243 clks->din_words_clk = devm_clk_get(&pdev->dev, "s_axis_din_words_aclk"); 1244 if (IS_ERR(clks->din_words_clk)) { 1245 if (PTR_ERR(clks->din_words_clk) != -ENOENT) { 1246 err = PTR_ERR(clks->din_words_clk); 1247 return err; 1248 } 1249 clks->din_words_clk = NULL; 1250 } 1251 1252 clks->din_clk = devm_clk_get(&pdev->dev, "s_axis_din_aclk"); 1253 if (IS_ERR(clks->din_clk)) { 1254 if (PTR_ERR(clks->din_clk) != -ENOENT) { 1255 err = PTR_ERR(clks->din_clk); 1256 return err; 1257 } 1258 clks->din_clk = NULL; 1259 } 1260 1261 clks->dout_clk = devm_clk_get(&pdev->dev, "m_axis_dout_aclk"); 1262 if (IS_ERR(clks->dout_clk)) { 1263 if (PTR_ERR(clks->dout_clk) != -ENOENT) { 1264 err = PTR_ERR(clks->dout_clk); 1265 return err; 1266 } 1267 clks->dout_clk = NULL; 1268 } 1269 1270 clks->dout_words_clk = 1271 devm_clk_get(&pdev->dev, "s_axis_dout_words_aclk"); 1272 if (IS_ERR(clks->dout_words_clk)) { 1273 if (PTR_ERR(clks->dout_words_clk) != -ENOENT) { 1274 err = PTR_ERR(clks->dout_words_clk); 1275 return err; 1276 } 1277 clks->dout_words_clk = NULL; 1278 } 1279 1280 clks->ctrl_clk = devm_clk_get(&pdev->dev, "s_axis_ctrl_aclk"); 1281 if (IS_ERR(clks->ctrl_clk)) { 1282 if (PTR_ERR(clks->ctrl_clk) != -ENOENT) { 1283 err = PTR_ERR(clks->ctrl_clk); 1284 return err; 1285 } 1286 clks->ctrl_clk = NULL; 1287 } 1288 1289 clks->status_clk = devm_clk_get(&pdev->dev, "m_axis_status_aclk"); 1290 if (IS_ERR(clks->status_clk)) { 1291 if (PTR_ERR(clks->status_clk) != -ENOENT) { 1292 err = PTR_ERR(clks->status_clk); 1293 return err; 1294 } 1295 clks->status_clk = NULL; 1296 } 1297 1298 err = clk_prepare_enable(clks->core_clk); 1299 if (err) { 1300 dev_err(&pdev->dev, "failed to enable core_clk (%d)", err); 1301 return err; 1302 } 1303 1304 err = clk_prepare_enable(clks->axi_clk); 1305 if (err) { 1306 dev_err(&pdev->dev, "failed to enable axi_clk (%d)", err); 1307 goto err_disable_core_clk; 1308 } 1309 1310 err = clk_prepare_enable(clks->din_clk); 1311 if (err) { 1312 dev_err(&pdev->dev, "failed to enable din_clk (%d)", err); 1313 goto err_disable_axi_clk; 1314 } 1315 1316 err = clk_prepare_enable(clks->din_words_clk); 1317 if (err) { 1318 dev_err(&pdev->dev, "failed to enable din_words_clk (%d)", err); 1319 goto err_disable_din_clk; 1320 } 1321 1322 err = clk_prepare_enable(clks->dout_clk); 1323 if (err) { 1324 dev_err(&pdev->dev, "failed to enable dout_clk (%d)", err); 1325 goto err_disable_din_words_clk; 1326 } 1327 1328 err = clk_prepare_enable(clks->dout_words_clk); 1329 if (err) { 1330 dev_err(&pdev->dev, "failed to enable dout_words_clk (%d)", 1331 err); 1332 goto err_disable_dout_clk; 1333 } 1334 1335 err = clk_prepare_enable(clks->ctrl_clk); 1336 if (err) { 1337 dev_err(&pdev->dev, "failed to enable ctrl_clk (%d)", err); 1338 goto err_disable_dout_words_clk; 1339 } 1340 1341 err = clk_prepare_enable(clks->status_clk); 1342 if (err) { 1343 dev_err(&pdev->dev, "failed to enable status_clk (%d)\n", err); 1344 goto err_disable_ctrl_clk; 1345 } 1346 1347 return err; 1348 1349 err_disable_ctrl_clk: 1350 clk_disable_unprepare(clks->ctrl_clk); 1351 err_disable_dout_words_clk: 1352 clk_disable_unprepare(clks->dout_words_clk); 1353 err_disable_dout_clk: 1354 clk_disable_unprepare(clks->dout_clk); 1355 err_disable_din_words_clk: 1356 clk_disable_unprepare(clks->din_words_clk); 1357 err_disable_din_clk: 1358 clk_disable_unprepare(clks->din_clk); 1359 err_disable_axi_clk: 1360 clk_disable_unprepare(clks->axi_clk); 1361 err_disable_core_clk: 1362 clk_disable_unprepare(clks->core_clk); 1363 1364 return err; 1365 } 1366 1367 static void xsdfec_disable_all_clks(struct xsdfec_clks *clks) 1368 { 1369 clk_disable_unprepare(clks->status_clk); 1370 clk_disable_unprepare(clks->ctrl_clk); 1371 clk_disable_unprepare(clks->dout_words_clk); 1372 clk_disable_unprepare(clks->dout_clk); 1373 clk_disable_unprepare(clks->din_words_clk); 1374 clk_disable_unprepare(clks->din_clk); 1375 clk_disable_unprepare(clks->core_clk); 1376 clk_disable_unprepare(clks->axi_clk); 1377 } 1378 1379 static int xsdfec_probe(struct platform_device *pdev) 1380 { 1381 struct xsdfec_dev *xsdfec; 1382 struct device *dev; 1383 struct resource *res; 1384 int err; 1385 bool irq_enabled = true; 1386 1387 xsdfec = devm_kzalloc(&pdev->dev, sizeof(*xsdfec), GFP_KERNEL); 1388 if (!xsdfec) 1389 return -ENOMEM; 1390 1391 xsdfec->dev = &pdev->dev; 1392 spin_lock_init(&xsdfec->error_data_lock); 1393 1394 err = xsdfec_clk_init(pdev, &xsdfec->clks); 1395 if (err) 1396 return err; 1397 1398 dev = xsdfec->dev; 1399 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 1400 xsdfec->regs = devm_ioremap_resource(dev, res); 1401 if (IS_ERR(xsdfec->regs)) { 1402 err = PTR_ERR(xsdfec->regs); 1403 goto err_xsdfec_dev; 1404 } 1405 1406 xsdfec->irq = platform_get_irq(pdev, 0); 1407 if (xsdfec->irq < 0) { 1408 dev_dbg(dev, "platform_get_irq failed"); 1409 irq_enabled = false; 1410 } 1411 1412 err = xsdfec_parse_of(xsdfec); 1413 if (err < 0) 1414 goto err_xsdfec_dev; 1415 1416 update_config_from_hw(xsdfec); 1417 1418 /* Save driver private data */ 1419 platform_set_drvdata(pdev, xsdfec); 1420 1421 if (irq_enabled) { 1422 init_waitqueue_head(&xsdfec->waitq); 1423 /* Register IRQ thread */ 1424 err = devm_request_threaded_irq(dev, xsdfec->irq, NULL, 1425 xsdfec_irq_thread, IRQF_ONESHOT, 1426 "xilinx-sdfec16", xsdfec); 1427 if (err < 0) { 1428 dev_err(dev, "unable to request IRQ%d", xsdfec->irq); 1429 goto err_xsdfec_dev; 1430 } 1431 } 1432 1433 err = ida_alloc(&dev_nrs, GFP_KERNEL); 1434 if (err < 0) 1435 goto err_xsdfec_dev; 1436 xsdfec->dev_id = err; 1437 1438 snprintf(xsdfec->dev_name, DEV_NAME_LEN, "xsdfec%d", xsdfec->dev_id); 1439 xsdfec->miscdev.minor = MISC_DYNAMIC_MINOR; 1440 xsdfec->miscdev.name = xsdfec->dev_name; 1441 xsdfec->miscdev.fops = &xsdfec_fops; 1442 xsdfec->miscdev.parent = dev; 1443 err = misc_register(&xsdfec->miscdev); 1444 if (err) { 1445 dev_err(dev, "error:%d. Unable to register device", err); 1446 goto err_xsdfec_ida; 1447 } 1448 return 0; 1449 1450 err_xsdfec_ida: 1451 ida_free(&dev_nrs, xsdfec->dev_id); 1452 err_xsdfec_dev: 1453 xsdfec_disable_all_clks(&xsdfec->clks); 1454 return err; 1455 } 1456 1457 static int xsdfec_remove(struct platform_device *pdev) 1458 { 1459 struct xsdfec_dev *xsdfec; 1460 1461 xsdfec = platform_get_drvdata(pdev); 1462 misc_deregister(&xsdfec->miscdev); 1463 ida_free(&dev_nrs, xsdfec->dev_id); 1464 xsdfec_disable_all_clks(&xsdfec->clks); 1465 return 0; 1466 } 1467 1468 static const struct of_device_id xsdfec_of_match[] = { 1469 { 1470 .compatible = "xlnx,sd-fec-1.1", 1471 }, 1472 { /* end of table */ } 1473 }; 1474 MODULE_DEVICE_TABLE(of, xsdfec_of_match); 1475 1476 static struct platform_driver xsdfec_driver = { 1477 .driver = { 1478 .name = "xilinx-sdfec", 1479 .of_match_table = xsdfec_of_match, 1480 }, 1481 .probe = xsdfec_probe, 1482 .remove = xsdfec_remove, 1483 }; 1484 1485 static int __init xsdfec_init(void) 1486 { 1487 int err; 1488 1489 err = platform_driver_register(&xsdfec_driver); 1490 if (err < 0) { 1491 pr_err("%s Unabled to register SDFEC driver", __func__); 1492 return err; 1493 } 1494 return 0; 1495 } 1496 1497 static void __exit xsdfec_exit(void) 1498 { 1499 platform_driver_unregister(&xsdfec_driver); 1500 } 1501 1502 module_init(xsdfec_init); 1503 module_exit(xsdfec_exit); 1504 1505 MODULE_AUTHOR("Xilinx, Inc"); 1506 MODULE_DESCRIPTION("Xilinx SD-FEC16 Driver"); 1507 MODULE_LICENSE("GPL"); 1508