(no commit message)
[libreriscv.git] / shakti / m_class / pinmux.mdwn
1 # Pin Multiplexing
2
3 * <http://bugs.libre-riscv.org/show_bug.cgi?id=8>
4 * <https://github.com/sifive/sifive-blocks/tree/master/src/main/scala/devices/>
5 includes GPIO, SPI, UART, JTAG, I2C, PinCtrl, UART and PWM. Also included
6 is a Watchdog Timer and others.
7 * <https://github.com/sifive/freedom/blob/master/src/main/scala/everywhere/e300artydevkit/Platform.scala>
8 Pinmux ("IOF") for multiplexing several I/O functions onto a single pin
9
10 Complex!
11
12 # Requirements
13
14 "to create a general-purpose libre-licensed pinmux
15 module that can be used with a wide range of interfaces that have
16 Open-Drain, Push-Push *and bi-directional* capabilities, as well as
17 optional pull-up and pull-down resistors, in an IDENTICAL fashion to
18 that of ALL major well-known embedded SoCs from ST Micro, Cypress,
19 Texas Instruments, NXP, Rockchip, Allwinner and many many others".
20
21 ## Analysis
22
23 Questions:
24
25 * Can damage occur (to the ASIC) by outputs being short-circuited to outputs
26 in any way?
27 A partial analysis showed that because outputs are one-to-many, there should
28 not be a possibility for that to occur. However what if a function is
29 bi-directional?
30 * Is de-bouncing always needed on every input? Is it ok for de-bouncing
31 to be only done on EINT?
32
33 # GSoC2018
34
35 Introductions:
36
37 * Luke Kenneth Casson Leighton (lkcl) - reverse-engineer, software libre
38 advocate, assembly-level programming and disassembly, python, c, c++,
39 gate-level circuit and ASIC design, PCB design and assembly, 3D CAD design,
40 lots of different stuff. Guardian of the EOMA68 Certification Mark,
41 and currently responsible for coordinating the design of a fully Libre
42 RISC-V SoC in collaboration with the RISE Group, IIT Madras, Shakti Project.
43
44 # Discussion and Links
45
46 * <https://elinux.org/images/b/b6/Pin_Control_Subsystem_Overview.pdf>
47 * <https://lists.librecores.org/pipermail/discussion/2018-February/thread.html>
48 * <https://lists.librecores.org/pipermail/discussion/2018-January/000404.html>
49
50 # Pinouts Specification
51
52 Covered in [[pinouts]]. The general idea is to target several
53 distinct applications and, by trial-and-error, create a pinmux table that
54 successfully covers all the target scenarios by providing absolutely all
55 required functions for each and every target. A few general rules:
56
57 * Different functions (SPI, I2C) which overlap on the same pins on one
58 bank should also be duplicated on completely different banks, both from
59 each other and also the bank on which they overlap. With each bank having
60 separate Power Domains this strategy increases the chances of being able
61 to place low-power and high-power peripherals and sensors on separate
62 GPIO banks without needing external level-shifters.
63 * Functions which have optional bus-widths (eMMC: 1/2/4/8) may have more
64 functions overlapping them than would otherwise normally be considered.
65 * Then the same overlapped high-order bus pins can also be mapped onto
66 other pins. This particularly applies to the very large buses, such
67 as FlexBus (over 50 pins). However if the overlapped pins are on a
68 different bank it becomes necessary to have both banks run in the same
69 GPIO Power Domain.
70 * All functions should really be pin-muxed at least twice, preferably
71 three times. Four or more times on average makes it pointless to
72 even have four-way pinmuxing at all, so this should be avoided.
73 The only exceptions (functions which have not been pinmuxed multiple
74 times) are the RGB/TTL LCD channel, and both ULPI interfaces.
75
76 # GPIO Pinmux Power Domains
77
78 Of particular importance is the Power Domains for the GPIO. Realistically
79 it has to be flexible (simplest option: recommended to be between
80 1.8v and 3.3v) as the majority of low-cost mass-produced sensors and
81 peripherals on I2C, SPI, UART and SD/MMC are at or are compatible with
82 this voltage range. Long-tail (older / stable / low-cost / mass-produced)
83 peripherals in particular tend to be 3.3v, whereas newer ones with a
84 particular focus on Mobile tend to be 1.2v to 1.8v.
85
86 A large percentage of sensors and peripherals have separate IO voltage
87 domains from their main supply voltage: a good example is the SN75LVDS83b
88 which has one power domain for the RGB/TTL I/O, one for the LVDS output,
89 and one for the internal logic controller (typical deployments tend not
90 to notice the different power-domain capability, as they usually supply all
91 three voltages at 3.3v).
92
93 Relying on this capability, however, by selecting a fixed voltage for
94 the entire SoC's GPIO domain, is simply not a good idea: all sensors
95 and peripherals which do not have a variable (VREF) capability for the
96 logic side, or coincidentally are not at the exact same fixed voltage,
97 will simply not be compatible if they are high-speed CMOS-level push-push
98 driven. Open-Drain on the other hand can be handled with a MOSFET for
99 two-way or even a diode for one-way depending on the levels, but this means
100 significant numbers of external components if the number of lines is large.
101
102 So, selecting a fixed voltage (such as 1.8v or 3.3v) results in a bit of a
103 problem: external level-shifting is required on pretty much absolutely every
104 single pin, particularly the high-speed (CMOS) push-push I/O. An example: the
105 DM9000 is best run at 3.3v. A fixed 1.8v FlexBus would
106 require a whopping 18 pins (possibly even 24 for a 16-bit-wide bus)
107 worth of level-shifting, which is not just costly
108 but also a huge amount of PCB space: bear in mind that for level-shifting, an
109 IC with **double** the number of pins being level-shifted is required.
110
111 Given that level-shifting is an unavoidable necessity, and external
112 level-shifting has such high cost(s), the workable solution is to
113 actually include GPIO-group level-shifting actually on the SoC die,
114 after the pin-muxer at the front-end (on the I/O pads of the die),
115 on a per-bank basis. This is an extremely common technique that is
116 deployed across a very wide range of mass-volume SoCs.
117
118 One very useful side-effect for example of a variable Power Domain voltage
119 on a GPIO bank containing SD/MMC functionality is to be able to change the
120 bank's voltage from 3.3v to 1.8v, to match an SD Card's capabilities, as
121 permitted under the SD/MMC Specification. The alternative is to be forced to
122 deploy an external level-shifter IC (if PCB space and BOM target allows) or to
123 fix the voltage at 3.3v and thus lose access to the low-power and higher-speed
124 capabilities of modern SD Cards.
125
126 In summary: putting level shifters right at the I/O pads of the SoC, after
127 the pin-mux (so that the core logic remains at the core voltage) is a
128 cost-effective solution that can have additional unintended side-benefits
129 and cost savings beyond simply saving on external level-shifting components
130 and board space.
131