1 /* 2 * Copyright (C) 2017, 2018 Paul Boddie <paul@boddie.org.uk> 3 * 4 * This program is free software; you can redistribute it and/or 5 * modify it under the terms of the GNU General Public License as 6 * published by the Free Software Foundation; either version 2 of 7 * the License, or (at your option) any later version. 8 * 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * 14 * You should have received a copy of the GNU General Public License 15 * along with this program; if not, write to the Free Software 16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 17 * Boston, MA 02110-1301, USA 18 */ 19 20 #include <l4/devices/i2c-jz4780.h> 21 #include <l4/devices/hw_mmio_register_block.h> 22 23 #include <l4/sys/icu.h> 24 #include <l4/util/util.h> 25 #include <sys/time.h> 26 27 #include <cstdio> 28 29 /* 30 I2C pins: 31 32 I2C0: PD30/SMB0_SDA, PD31/SMB0_SCK 33 I2C1: PD30/SMB1_SDA, PD31/SMB1_SCK (pulled up on CI20) 34 I2C2: PF16/SMB2_SDA, PF17/SMB2_SCK 35 PWM: PD10/SMB3_SDA, PD11/SMB3_SCK 36 PWM: PE3/SMB4_SDA, PE4/SMB4_SCK 37 I2C4: PE12/SMB4_SDA, PE13/SMB4_SCK 38 HDMI: PF25/SMB4_SDA/DDCSDA, PF24/SMB4_SCK/DDCSCK 39 40 See: http://mipscreator.imgtec.com/CI20/hardware/board/ci20_jz4780_v2.0.pdf 41 */ 42 43 enum Regs 44 { 45 Smb_control = 0x000, // SMBCON 46 Smb_target_address = 0x004, // SMBTAR 47 Smb_slave_address = 0x008, // SMBSAR 48 Smb_data_command = 0x010, // SMBDC 49 Std_high_count = 0x014, // SMBSHCNT 50 Std_low_count = 0x018, // SMBSLCNT 51 Fast_high_count = 0x01c, // SMBFHCNT 52 Fast_low_count = 0x020, // SMBFLCNT 53 Int_status = 0x02c, // SMBINTST (read-only) 54 Int_mask = 0x030, // SMBINTM 55 56 Rx_fifo_thold = 0x038, // SMBRXTL 57 Tx_fifo_thold = 0x03c, // SMBTXTL 58 Int_combined_clear = 0x040, // SMBCINT (read-only) 59 Int_rx_uf_clear = 0x044, // SMBCRXUF (read-only) 60 Int_rx_of_clear = 0x048, // SMBCRXOF (read-only) 61 Int_tx_of_clear = 0x04c, // SMBCTXOF (read-only) 62 Int_rd_req_clear = 0x050, // SMBCRXREQ (read-only) 63 Int_tx_abort_clear = 0x054, // SMBCTXABT (read-only) 64 Int_rx_done_clear = 0x058, // SMBCRXDN (read-only) 65 Int_activity_clear = 0x05c, // SMBCACT (read-only) 66 Int_stop_clear = 0x060, // SMBCSTP (read-only) 67 Int_start_clear = 0x064, // SMBCSTT (read-only) 68 Int_call_clear = 0x068, // SMBCGC (read-only) 69 Smb_enable = 0x06c, // SMBENB 70 Smb_status = 0x070, // SMBST (read-only) 71 72 Tx_fifo_count = 0x074, // SMBTXFLR (read-only) 73 Rx_fifo_count = 0x078, // SMBRXFLR (read-only) 74 75 Trans_abort_status0 = 0x080, // SMBABTSRC (read-only) 76 Trans_abort_status1 = 0x084, // ... (read-only) 77 78 Smb_dma_ctrl = 0x088, // SMBDMACR 79 Smb_trans_data_lvl = 0x08c, // SMBDMATDLR 80 Smb_recv_data_lvl = 0x090, // SMBDMARDLR 81 Smb_sda_setup_time = 0x094, // SMBSDASU 82 Smb_ack_call = 0x098, // SMBACKGC 83 84 Smb_enable_status = 0x09c, // SMBENBST (read-only) 85 Smb_sda_hold_time = 0x0d0, // SMBSDAHD 86 87 Smb_block_offset = 0x1000 88 }; 89 90 enum Smb_control_bits : unsigned 91 { 92 Smb_no_stop_empty = 0x80, // STPHLD (no STP condition when queue empty) 93 Smb_disable_slave = 0x40, // SLVDIS (slave disabled) 94 Smb_enable_restart = 0x20, // REST 95 Smb_enable_master = 0x01, // MD (master enabled) 96 Smb_speed_bit = 1, // SPD 97 }; 98 99 enum Smb_enable_bits : unsigned 100 { 101 Smb_enable_enabled = 0x01, // SMBEN 102 }; 103 104 enum Smb_status_bits : unsigned 105 { 106 Smb_status_master_act = 0x20, // MSTACT (master active) 107 Smb_status_rx_nempty = 0x08, // RFNE (read queue not empty) 108 Smb_status_tx_empty = 0x04, // TFE (write queue empty) 109 Smb_status_tx_nfull = 0x02, // TFNF (write queue not full) 110 Smb_status_active = 0x01, // ACT (device active as master or slave) 111 }; 112 113 enum Smb_target_bits : unsigned 114 { 115 Smb_target_7bits = 0x7f, 116 }; 117 118 enum Smb_hold_control_bits : unsigned 119 { 120 Smb_hold_enable = 0x100, // HDENB 121 Smb_hold_disable = 0x000, // HDENB 122 Smb_hold_mask = 0x1ff, 123 }; 124 125 enum Smb_setup_control_bits : unsigned 126 { 127 Smb_setup_mask = 0x0ff, 128 }; 129 130 enum Smb_command_bits : unsigned 131 { 132 Smb_command_read = 0x100, // CMD 133 Smb_command_write = 0x000, // CMD 134 }; 135 136 enum Smb_fifo_bits : unsigned 137 { 138 Smb_fifo_limit = 16, 139 }; 140 141 enum Int_bits : unsigned 142 { 143 Int_call = 0x800, // IGC (general call received) 144 Int_start = 0x400, // ISTT (start/restart condition occurred) 145 Int_stop = 0x200, // ISTP (stop condition occurred) 146 Int_activity = 0x100, // IACT (bus activity interrupt) 147 Int_rx_done = 0x080, // RXDN (read from master device done) 148 Int_tx_abort = 0x040, // TXABT (transmit abort) 149 Int_rd_req = 0x020, // RDREQ (read request from master device) 150 Int_tx_empty = 0x010, // TXEMP (threshold reached or passed) 151 Int_tx_of = 0x008, // TXOF (overflow when writing to queue) 152 Int_rx_full = 0x004, // RXFL (threshold reached or exceeded) 153 Int_rx_of = 0x002, // RXOF (overflow from device) 154 Int_rx_uf = 0x001, // RXUF (underflow when reading from queue) 155 }; 156 157 158 159 // Initialise a channel. 160 161 I2c_jz4780_channel::I2c_jz4780_channel(l4_addr_t start, 162 Cpm_jz4780_chip *cpm, 163 uint32_t frequency) 164 : _cpm(cpm), _frequency(frequency) 165 { 166 _regs = new Hw::Mmio_register_block<32>(start); 167 } 168 169 // Enable the channel. 170 171 void 172 I2c_jz4780_channel::enable() 173 { 174 _regs[Smb_control] = _regs[Smb_control] | Smb_no_stop_empty; 175 176 _regs[Smb_enable] = Smb_enable_enabled; 177 while (!(_regs[Smb_enable_status] & Smb_enable_enabled)); 178 } 179 180 // Disable the channel. 181 182 void 183 I2c_jz4780_channel::disable() 184 { 185 _regs[Smb_enable] = 0; 186 while (_regs[Smb_enable_status] & Smb_enable_enabled); 187 } 188 189 // Set the frequency-related peripheral parameters. 190 191 void 192 I2c_jz4780_channel::set_frequency() 193 { 194 // The APB clock (PCLK) is used to drive I2C transfers. Its value must be 195 // obtained from the CPM unit. It is known as SMB_CLK here and is scaled to 196 // kHz in order to keep the numbers easily representable, as is the bus 197 // frequency. 198 199 uint32_t smb_clk = _cpm->get_pclock_frequency() / 1000; 200 uint32_t i2c_clk = _frequency / 1000; 201 unsigned speed = (i2c_clk <= 100) ? 1 : 2; 202 203 _regs[Smb_control] = _regs[Smb_control] | (speed << Smb_speed_bit) | 204 Smb_disable_slave | 205 Smb_enable_restart | 206 Smb_enable_master; 207 208 // According to the programming manual, if the PCLK period is T{SMB_CLK} 209 // then the I2C clock period is... 210 211 // T{SCL} = T{SCL_high} + T{SCL_low} 212 213 // Where... 214 215 // T{SCL_low} = T{SMB_CLK} * (#cycles for low signal) 216 // T{SCL_high} = T{SMB_CLK} * (#cycles for high signal) 217 218 // Since, with minimum periods being defined... 219 220 // T{SCL} >= T{min_SCL} 221 // T{SCL_low} >= T{min_SCL_low} 222 // T{SCL_high} >= T{min_SCL_high} 223 // T{min_SCL} = T{min_SCL_low} + T{min_SCL_high} 224 225 // Then the following applies... 226 227 // T{SMB_CLK} * (#cycles for low signal)) >= T{min_SCL_low} 228 // T{SMB_CLK} * (#cycles for high signal) >= T{min_SCL_high} 229 230 // To work with different clock speeds while maintaining the low-to-high 231 // ratios: 232 233 // T{min_SCL_low} = T{min_SCL} * T{min_SCL_low} / T{min_SCL} 234 // = T{min_SCL} * (T{min_SCL_low} / (T{min_SCL_low} + T{min_SCL_high})) 235 236 // T{min_SCL_high} = T{min_SCL} * T{min_SCL_high} / T{min_SCL} 237 // = T{min_SCL} * (T{min_SCL_high} / (T{min_SCL_low} + T{min_SCL_high})) 238 239 // Constraints are given with respect to the high and low count registers. 240 241 // #cycles for high signal = SMBxHCNT + 8 242 // #cycles for low signal = SMBxLCNT + 1 243 244 // From earlier, this yields... 245 246 // T{SMB_CLK} * (SMBxLCNT + 1) >= T{min_SCL_low} 247 // T{SMB_CLK} * (SMBxHCNT + 8) >= T{min_SCL_high} 248 249 // Rearranging... 250 251 // SMBxLCNT >= (T{min_SCL_low} / T{SMB_CLK}) - 1 252 // >= T{min_SCL_low} * SMB_CLK - 1 253 254 // SMBxHCNT >= (T{min_SCL_high} / T{SMB_CLK}) - 8 255 // >= T{min_SCL_high} * SMB_CLK - 8 256 257 // Introducing the definitions for the high and low periods... 258 259 // SMBxLCNT >= T{min_SCL} * (T{min_SCL_low} / (T{min_SCL_low} + T{min_SCL_high})) * SMB_CLK - 1 260 // >= (T{min_SCL_low} / T{min_SCL}) * SMB_CLK / I2C_CLK - 1 261 262 // SMBxHCNT >= T{min_SCL} * (T{min_SCL_high} / (T{min_SCL_low} + T{min_SCL_high})) * SMB_CLK - 8 263 // >= (T{min_SCL_high} / T{min_SCL}) * SMB_CLK / I2C_CLK - 8 264 265 uint32_t high_reg, low_reg; 266 uint32_t high_count, low_count; 267 uint32_t hold_count, setup_count; 268 269 // Level hold times: 270 271 // Standard Fast 272 // SCL low 4.7us 1.3us 273 // SCL high 4.0us 0.6us + 274 // SCL period 8.7us 1.9us = 275 276 if (i2c_clk <= 100) // 100 kHz 277 { 278 low_count = (smb_clk * 47) / (i2c_clk * 87) - 1; 279 high_count = (smb_clk * 40) / (i2c_clk * 87) - 8; 280 low_reg = Std_low_count; 281 high_reg = Std_high_count; 282 } 283 else 284 { 285 low_count = (smb_clk * 13) / (i2c_clk * 19) - 1; 286 high_count = (smb_clk * 6) / (i2c_clk * 19) - 8; 287 low_reg = Fast_low_count; 288 high_reg = Fast_high_count; 289 } 290 291 // Minimum counts are 8 and 6 for low and high respectively. 292 293 _regs[low_reg] = low_count < 8 ? 8 : low_count; 294 _regs[high_reg] = high_count < 6 ? 6 : high_count; 295 296 // Data hold and setup times: 297 298 // Standard Fast 299 // t{HD;DAT} 300ns 300ns 300 // t{SU;DAT} 250ns 100ns 301 302 // T{delay} = (SMBSDAHD + 1) * T{SMB_CLK} 303 // SMBSDAHD = T{delay} / T{SMB_CLK} - 1 304 // SMBSDAHD = SMB_CLK * T{delay} - 1 305 306 hold_count = (smb_clk * 300) / 1000000 - 1; 307 308 _regs[Smb_sda_hold_time] = (_regs[Smb_sda_hold_time] & ~Smb_hold_mask) | 309 (hold_count > 0 ? Smb_hold_enable : Smb_hold_disable) | 310 (hold_count < 255 ? hold_count : 255); 311 312 // T{delay} = (SMBSDASU - 1) * T{SMB_CLK} 313 // SMBSDASU = T{delay} / T{SMB_CLK} + 1 314 // SMBSDASU = SMB_CLK * T{delay} + 1 315 316 if (i2c_clk <= 100) 317 setup_count = (smb_clk * 250) / 1000000 + 1; 318 else 319 setup_count = (smb_clk * 100) / 1000000 + 1; 320 321 _regs[Smb_sda_setup_time] = (_regs[Smb_sda_setup_time] & ~Smb_setup_mask) | 322 (setup_count < 255 ? setup_count : 255); 323 } 324 325 // Set the target address and enable transfer. 326 // NOTE: Only supporting 7-bit addresses currently. 327 328 void 329 I2c_jz4780_channel::set_target(uint8_t address) 330 { 331 disable(); 332 set_frequency(); 333 _regs[Smb_target_address] = address & Smb_target_7bits; 334 enable(); 335 init_parameters(); 336 queued = 0; 337 } 338 339 340 341 // Reset interrupt flags upon certain conditions. 342 343 void 344 I2c_jz4780_channel::reset_flags() 345 { 346 volatile uint32_t r; 347 348 _regs[Int_mask] = 0; 349 350 // Read from the register to clear interrupts. 351 352 r = _regs[Int_combined_clear]; 353 (void) r; 354 } 355 356 // Initialise interrupt flags and queue thresholds for reading and writing. 357 358 void 359 I2c_jz4780_channel::init_parameters() 360 { 361 // Handle read queue conditions for data, write queue conditions for commands. 362 363 reset_flags(); 364 365 _regs[Int_mask] = Int_rx_full | // read condition (reading needed) 366 Int_rx_of | // abort condition 367 Int_tx_empty | // write condition (writing needed) 368 Int_tx_abort; // abort condition 369 370 _regs[Tx_fifo_thold] = 0; // write when 0 in queue 371 372 // Make sure that the stop condition does not occur automatically. 373 374 _regs[Smb_control] = _regs[Smb_control] | Smb_no_stop_empty; 375 } 376 377 378 379 // Return whether the device is active. 380 381 int 382 I2c_jz4780_channel::active() 383 { 384 return _regs[Smb_status] & Smb_status_master_act; 385 } 386 387 // Return whether data is available to receive. 388 389 int 390 I2c_jz4780_channel::have_input() 391 { 392 return _regs[Smb_status] & Smb_status_rx_nempty; 393 } 394 395 // Return whether data is queued for sending. 396 397 int 398 I2c_jz4780_channel::have_output() 399 { 400 return !(_regs[Smb_status] & Smb_status_tx_empty); 401 } 402 403 // Return whether data can be queued for sending. 404 405 int 406 I2c_jz4780_channel::can_send() 407 { 408 return _regs[Smb_status] & Smb_status_tx_nfull; 409 } 410 411 // Return whether a receive operation has failed. 412 413 int 414 I2c_jz4780_channel::read_failed() 415 { 416 return _regs[Int_status] & Int_rx_of; 417 } 418 419 // Return whether a send operation has failed. 420 421 int 422 I2c_jz4780_channel::write_failed() 423 { 424 return _regs[Int_status] & Int_tx_abort; 425 } 426 427 428 429 // Send read commands for empty queue entries. 430 431 void 432 I2c_jz4780_channel::queue_reads() 433 { 434 unsigned remaining = _total - _reqpos; 435 unsigned can_queue = Smb_fifo_limit - queued + 1; 436 437 if (!remaining) 438 { 439 _regs[Smb_data_command] = Smb_command_read; 440 return; 441 } 442 443 // Keep the number of reads in progress below the length of the read queue. 444 445 if (!can_queue) 446 { 447 //printf("remaining=%d queued=%d\n", remaining, queued); 448 return; 449 } 450 451 if (remaining < can_queue) 452 can_queue = remaining; 453 454 // Queue read requests for any remaining queue entries. 455 456 for (unsigned i = 0; i < can_queue; i++) 457 _regs[Smb_data_command] = Smb_command_read; 458 459 // Track queued messages and requested positions. 460 461 queued += can_queue; 462 _reqpos += can_queue; 463 464 if (_total == _reqpos) 465 printf("Written %d read requests.\n", _reqpos); 466 } 467 468 // Send write commands for empty queue entries. 469 470 void 471 I2c_jz4780_channel::queue_writes(uint8_t buf[], unsigned *pos, unsigned total) 472 { 473 // Queue write requests for any remaining queue entries. 474 475 while ((*pos < total) && can_send() && !write_failed()) 476 { 477 _regs[Smb_data_command] = Smb_command_write | buf[*pos]; 478 (*pos)++; 479 } 480 } 481 482 // Store read command results from the queue. 483 484 void 485 I2c_jz4780_channel::store_reads() 486 { 487 int have_read = 0; 488 489 // Read any input and store it in the buffer. 490 491 while (have_input() && (_pos < _total)) 492 { 493 _buf[_pos] = _regs[Smb_data_command] & 0xff; 494 queued--; 495 _pos++; 496 497 have_read = 1; 498 } 499 500 // Update the threshold to be notified of any reduced remaining amount. 501 502 if (have_read) 503 set_read_threshold(); 504 505 //printf("Read to %d, still %d queued.\n", _pos, queued); 506 } 507 508 // Read from the target device. 509 510 void 511 I2c_jz4780_channel::start_read(uint8_t buf[], unsigned total) 512 { 513 printf("intst=%x\n", (uint32_t) _regs[Int_status]); 514 515 _buf = buf; 516 _total = total; 517 _pos = 0; 518 _reqpos = 0; 519 _fail = 0; 520 _stop = 0; 521 522 set_read_threshold(); 523 } 524 525 void 526 I2c_jz4780_channel::set_read_threshold() 527 { 528 unsigned remaining = _total - _pos; 529 530 if (!remaining) 531 return; 532 533 if (remaining <= Smb_fifo_limit) 534 _regs[Rx_fifo_thold] = remaining - 1; // read all remaining 535 else 536 _regs[Rx_fifo_thold] = Smb_fifo_limit - 1; // read to limit 537 538 //printf("rxthold=%d\n", (uint32_t) _regs[Rx_fifo_thold] + 1); 539 } 540 541 void 542 I2c_jz4780_channel::read() 543 { 544 if (read_failed() || write_failed()) 545 { 546 printf("intst*=%x\n", (uint32_t) _regs[Int_status]); 547 printf("rxfifo=%d\n", (uint32_t) _regs[Rx_fifo_count] & 0x3f); 548 printf("smbabtsrc=%x\n", (uint32_t) _regs[Trans_abort_status0]); 549 _fail = 1; 550 return; 551 } 552 553 //printf("rxfifo=%d\n", (uint32_t) _regs[Rx_fifo_count]); 554 //printf("intst=%x\n", (uint32_t) _regs[Int_status]); 555 556 if (_pos < _total) 557 { 558 if (_regs[Int_status] & Int_rx_full) 559 store_reads(); 560 if (_regs[Int_status] & Int_tx_empty) 561 queue_reads(); 562 } 563 else 564 { 565 stop(); 566 _regs[Int_mask] = 0; 567 } 568 } 569 570 int 571 I2c_jz4780_channel::read_done() 572 { 573 return _pos == _total; 574 } 575 576 unsigned 577 I2c_jz4780_channel::have_read() 578 { 579 return _pos; 580 } 581 582 int 583 I2c_jz4780_channel::read_incomplete() 584 { 585 return _fail; 586 } 587 588 // Write to the target device. 589 590 void 591 I2c_jz4780_channel::write(uint8_t buf[], unsigned total) 592 { 593 unsigned pos = 0; 594 595 while ((pos < total) && !write_failed()) 596 { 597 queue_writes(buf, &pos, total); 598 } 599 } 600 601 // Explicitly stop communication. 602 603 void 604 I2c_jz4780_channel::stop() 605 { 606 if (_stop) 607 return; 608 609 _regs[Smb_control] = _regs[Smb_control] & ~Smb_no_stop_empty; 610 _stop = 1; 611 printf("Stop sent.\n"); 612 } 613 614 615 616 // Initialise the I2C controller. 617 618 I2c_jz4780_chip::I2c_jz4780_chip(l4_addr_t start, l4_addr_t end, 619 Cpm_jz4780_chip *cpm, 620 uint32_t frequency) 621 : _start(start), _end(end), _cpm(cpm), _frequency(frequency) 622 { 623 } 624 625 // Obtain a channel object. 626 627 I2c_jz4780_channel * 628 I2c_jz4780_chip::get_channel(uint8_t channel) 629 { 630 l4_addr_t block = _start + channel * Smb_block_offset; 631 632 if (block < _end) 633 { 634 _cpm->start_i2c(channel); 635 return new I2c_jz4780_channel(block, _cpm, _frequency); 636 } 637 else 638 throw -L4_EINVAL; 639 } 640 641 642 643 // C language interface functions. 644 645 void *jz4780_i2c_init(l4_addr_t start, l4_addr_t end, void *cpm, uint32_t frequency) 646 { 647 return (void *) new I2c_jz4780_chip(start, end, static_cast<Cpm_jz4780_chip *>(cpm), frequency); 648 } 649 650 void *jz4780_i2c_get_channel(void *i2c, uint8_t channel) 651 { 652 return static_cast<I2c_jz4780_chip *>(i2c)->get_channel(channel); 653 } 654 655 void jz4780_i2c_set_target(void *i2c_channel, uint8_t addr) 656 { 657 static_cast<I2c_jz4780_channel *>(i2c_channel)->set_target(addr); 658 } 659 660 void jz4780_i2c_start_read(void *i2c_channel, uint8_t buf[], unsigned total) 661 { 662 static_cast<I2c_jz4780_channel *>(i2c_channel)->start_read(buf, total); 663 } 664 665 void jz4780_i2c_read(void *i2c_channel) 666 { 667 static_cast<I2c_jz4780_channel *>(i2c_channel)->read(); 668 } 669 670 int jz4780_i2c_read_done(void *i2c_channel) 671 { 672 return static_cast<I2c_jz4780_channel *>(i2c_channel)->read_done(); 673 } 674 675 unsigned jz4780_i2c_have_read(void *i2c_channel) 676 { 677 return static_cast<I2c_jz4780_channel *>(i2c_channel)->have_read(); 678 } 679 680 int jz4780_i2c_read_incomplete(void *i2c_channel) 681 { 682 return static_cast<I2c_jz4780_channel *>(i2c_channel)->read_incomplete(); 683 } 684 685 void jz4780_i2c_write(void *i2c_channel, uint8_t buf[], unsigned total) 686 { 687 static_cast<I2c_jz4780_channel *>(i2c_channel)->write(buf, total); 688 } 689 690 void jz4780_i2c_stop(void *i2c_channel) 691 { 692 static_cast<I2c_jz4780_channel *>(i2c_channel)->stop(); 693 }