commit a0e03bb9a4275104cf08c0c8f0dc5514930c8f1e Author: GHA Date: Fri Apr 21 01:14:28 2023 +0000 update 8c74c1794b25de11f442ca0697e148a66dfe81f3 diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 0000000..d474e82 --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: ee76fe7757e9c92a05b8ad8b4d9d5bf7 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/_images/Zadig-Setup.png b/_images/Zadig-Setup.png new file mode 100644 index 0000000..f8682bc Binary files /dev/null and b/_images/Zadig-Setup.png differ diff --git a/_images/blinky.gif b/_images/blinky.gif new file mode 100644 index 0000000..4e7a525 Binary files /dev/null and b/_images/blinky.gif differ diff --git a/_images/blinky_board_options.gif b/_images/blinky_board_options.gif new file mode 100644 index 0000000..22b7ae3 Binary files /dev/null and b/_images/blinky_board_options.gif differ diff --git a/_images/blinky_board_rules.png b/_images/blinky_board_rules.png new file mode 100644 index 0000000..5d4b72f Binary files /dev/null and b/_images/blinky_board_rules.png differ diff --git a/_images/blinky_diagram.png b/_images/blinky_diagram.png new file mode 100644 index 0000000..a0809ae Binary files /dev/null and b/_images/blinky_diagram.png differ diff --git a/_images/blinky_module_rules.png b/_images/blinky_module_rules.png new file mode 100644 index 0000000..db9f63d Binary files /dev/null and b/_images/blinky_module_rules.png differ diff --git a/_images/blinky_steps.png b/_images/blinky_steps.png new file mode 100644 index 0000000..5aa0271 Binary files /dev/null and b/_images/blinky_steps.png differ diff --git a/_images/blinky_video.gif b/_images/blinky_video.gif new file mode 100644 index 0000000..4616152 Binary files /dev/null and b/_images/blinky_video.gif differ diff --git a/_images/clk_buffering.png b/_images/clk_buffering.png new file mode 100644 index 0000000..5fa115d Binary files /dev/null and b/_images/clk_buffering.png differ diff --git a/_images/fomu-block-diagram.png b/_images/fomu-block-diagram.png new file mode 100644 index 0000000..9087053 Binary files /dev/null and b/_images/fomu-block-diagram.png differ diff --git a/_images/hw-hacker-annotated.png b/_images/hw-hacker-annotated.png new file mode 100644 index 0000000..9fb5f1c Binary files /dev/null and b/_images/hw-hacker-annotated.png differ diff --git a/_images/hw-hacker-back-bare-small.jpg b/_images/hw-hacker-back-bare-small.jpg new file mode 100644 index 0000000..d2061a2 Binary files /dev/null and b/_images/hw-hacker-back-bare-small.jpg differ diff --git a/_images/hw-hacker-back-case-small.jpg b/_images/hw-hacker-back-case-small.jpg new file mode 100644 index 0000000..ad7cba5 Binary files /dev/null and b/_images/hw-hacker-back-case-small.jpg differ diff --git a/_images/hw-hacker-front-bare-small.jpg b/_images/hw-hacker-front-bare-small.jpg new file mode 100644 index 0000000..435e5a1 Binary files /dev/null and b/_images/hw-hacker-front-bare-small.jpg differ diff --git a/_images/hw-pvt-annotated.png b/_images/hw-pvt-annotated.png new file mode 100644 index 0000000..5034c69 Binary files /dev/null and b/_images/hw-pvt-annotated.png differ diff --git a/_images/hw-pvt-back-bare-small.jpg b/_images/hw-pvt-back-bare-small.jpg new file mode 100644 index 0000000..7baf69f Binary files /dev/null and b/_images/hw-pvt-back-bare-small.jpg differ diff --git a/_images/hw-pvt-front-bare-small.jpg b/_images/hw-pvt-front-bare-small.jpg new file mode 100644 index 0000000..f105507 Binary files /dev/null and b/_images/hw-pvt-front-bare-small.jpg differ diff --git a/_images/ice40-arch.png b/_images/ice40-arch.png new file mode 100644 index 0000000..f3d800f Binary files /dev/null and b/_images/ice40-arch.png differ diff --git a/_images/ice40-ledd.png b/_images/ice40-ledd.png new file mode 100644 index 0000000..dec6269 Binary files /dev/null and b/_images/ice40-ledd.png differ diff --git a/_images/ice40-lut.png b/_images/ice40-lut.png new file mode 100644 index 0000000..84cfc36 Binary files /dev/null and b/_images/ice40-lut.png differ diff --git a/_images/ice40-plb.png b/_images/ice40-plb.png new file mode 100644 index 0000000..6b390eb Binary files /dev/null and b/_images/ice40-plb.png differ diff --git a/_images/ice40-rgb.png b/_images/ice40-rgb.png new file mode 100644 index 0000000..9900d42 Binary files /dev/null and b/_images/ice40-rgb.png differ diff --git a/_images/litex-design.png b/_images/litex-design.png new file mode 100644 index 0000000..2ea736d Binary files /dev/null and b/_images/litex-design.png differ diff --git a/_images/logo.png b/_images/logo.png new file mode 100644 index 0000000..8a933ca Binary files /dev/null and b/_images/logo.png differ diff --git a/_images/pwm_generator.png b/_images/pwm_generator.png new file mode 100644 index 0000000..122b2b7 Binary files /dev/null and b/_images/pwm_generator.png differ diff --git a/_images/sb_rgba_drv.png b/_images/sb_rgba_drv.png new file mode 100644 index 0000000..851ad26 Binary files /dev/null and b/_images/sb_rgba_drv.png differ diff --git a/_images/verilog-synthesis.png b/_images/verilog-synthesis.png new file mode 100644 index 0000000..044bc56 Binary files /dev/null and b/_images/verilog-synthesis.png differ diff --git a/_images/wishbone-usb-debug-bridge.png b/_images/wishbone-usb-debug-bridge.png new file mode 100644 index 0000000..0cc7330 Binary files /dev/null and b/_images/wishbone-usb-debug-bridge.png differ diff --git a/_sources/background.rst.txt b/_sources/background.rst.txt new file mode 100644 index 0000000..3f693ac --- /dev/null +++ b/_sources/background.rst.txt @@ -0,0 +1,217 @@ +.. _background: + +Background +---------- + +About FPGAs +~~~~~~~~~~~ + +`Field Programmable Gate Arrays (FPGAs) `_ +are integrated circuits containing arrays of gates which are programmable +in the field. Most chips you will encounter, have transistor gates arranged +in a fixed order, thus providing a fixed functionality. Conversely, FPGAs +can change their internal connections by simply loading new configurations. +Fundamentally, configurations program lookup tables (LUTs), which form the basic +building blocks of logic. These lookup tables are so important to the design and usage of an +FPGA that they usually form part of the name of the part. For example, +Fomu uses a `UP5K `_, +which has about 5000 LUTs. NeTV used an `LX9 `_, +which had about 9000 LUTs, and NeTV2 uses a `XC7A35T `_ +that has about 35000 LUTs. + +FPGA LUTs are almost always *n*-inputs to 1-output. The ICE family of +FPGAs from Lattice have 4-input LUTs. Xilinx parts tend to have 5-input or +6-input LUTs which generally means they can do more logic in fewer LUTs. +Comparing LUT count between FPGAs is a bit like comparing clock speed +between different CPUs; not entirely accurate, but certainly a helpful +rule of thumb. + +.. figure:: _static/ice40-lut.png + :width: 400px + :align: center + :alt: The ICE40 LUT4 is a basic 4-input 1-output LUT + + The ICE40 LUT4 is a basic 4-input 1-output function table. + +The basic building block of Fomu is the ``SB_LUT4``. It +has four 1-bit inputs and one 1-bit output. To program Fomu, we must define what +each possible input 4-bit pattern will create on the output. To do this, we turn to +a `truth table `_: + ++-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ +| | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | ++=====+=====+=====+=====+=====+=====+=====+=====+=====+=====+=====+=====+=====+=====+=====+=====+=====+ +| IO0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | ++-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ +| IO1 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | 1 | ++-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ +| IO2 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 1 | ++-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ +| IO3 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 | ++-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ +| O | *?* | *?* | *?* | *?* | *?* | *?* | *?* | *?* | *?* | *?* | *?* | *?* | *?* | *?* | *?* | *?* | ++-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ + +For example, to create a LUT that acted as an AND gate, we would define +``O`` to be 0 for everything except the last column. Conversely, to create +a NAND gate, we would define ``O`` to be 1 for everything except the last column. +It is from this simple primitive that we create the building logic blocks of +FPGA design. + +.. figure:: _static/ice40-plb.png + :width: 400px + :align: center + :alt: PLB Block Diagram (from iCE40 UltraPlus Family Data Sheet) + + Programmable Logic Block (PLB), Block Diagram. + +Modern FPGA devices are no longer composed of arrays of gates (i.e. LUTs) only. +Typically, LUTs are grouped with flip-flop registers (DFF) and some carry logic, in +so-called Programmable Logic Blocks (PLBs) or Configurable Logic Blocks (CLBs); +depending on the vendor. These resources allow combining multiple LUTs for +describing larger logical functions and for providing sequential behaviour. + +Furthermore, additional purpose-specific blocks are included in the devices: +Block RAMs (BRAMs), Digital Signal Processing (DSP) blocks, high-performance serial +transmitters/receivers, etc. Those so-called *hard* blocks allow better +area and power usage than LUT-based components. Nevertheless, the behaviour +of any of those *hard* blocks can be replicated using PLBs only. At the same time, +custom behaviour can only be described through LUTs, because all *hard* blocks +are programmable within the pre-fixed functionality only. + +.. _background:code-into-gates: + +Turning code into gates +^^^^^^^^^^^^^^^^^^^^^^^ + +Configuring all the LUTs, carry logic and other *hard* blocks manually is +hard and very challenging; so people have come up with abstract +`Hardware Description Languages (HDLs) `_, +that allow us to describe the expected behaviour and/or structure. The +two most common languages are Verilog and VHDL. However, a modern trend +is to achieve hardware description by embedding a Domain Specific Language (DSL) +inside an existing programming language, such as how Migen is embedded in Python, +Clash is embedded in Haskell, or Chisel and SpinalHDL are embedded in Scala. + +Here is an example of a counter module with a registered output: + +.. tabs:: + + .. group-tab:: Verilog + + .. code:: verilog + + module example ( + input C, + output reg [0:5] Q + ); + reg [0:8] counter; + + always @(posedge C) + begin + counter <= counter + 1'b1; + end + + always @(posedge C) + begin + Q <= counter[3] ^ counter[5] | counter<<2; + end + endmodule + +We can run this HDL module through a synthesizer to turn it into +LUT and DFF blocks, or we can turn it into a more familiar logic +diagram: + +.. figure:: _static/verilog-synthesis.png + :align: center + :width: 600px + :alt: A synthesis of the above logic into some gates + + A synthesis of the above logic into basic blocks. + +Turning gates into a bitstream +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If we do decide to synthesize to PLBs, we will end up with +a pile of LUTs and DFFs that need to be strung together somehow. This is done by +a Place-and-Route (PnR) tool. This performs the job of assigning physical PLBs +to each LUT and DFF that gets defined by the synthesizer; and then figuring out +how to wire it all up. + +Once the PnR tool is done, it generates an abstract file that needs to be +translated into a format that the hardware can recognize. This is done by a +bitstream packing tool. + +Loading a bitstream into a device +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Finally, the bitstream needs to be loaded onto the device somehow. It can be +done manually by toggling wires of the FPGAs programming interface. However, +most FPGAs are volatile, which means the configuration is lost when +unplugged. Therefore, most FPGA boards include some flash memory, which is +typically programmed through SPI. Then, when the FPGA is plugged again, it loads +the configuration from a predefined location in the flash. + +About the ICE40UP5K +~~~~~~~~~~~~~~~~~~~ + +We will use an ICE40UP5K for this workshop. This chip has a number of +very nice features: + +1. 5280 4-input LUTs (LC) +2. 16 kilobytes BRAM +3. **128 kilobytes “SPRAM”** +4. 1x Current-limited 3-channel LED driver +5. 2x I2C and 2x SPI interfaces +6. 8x 16-bit DSP units +7. **Warmboot capability** +8. **Open toolchain** + +.. figure:: _static/ice40-arch.png + :width: 400px + :align: center + :alt: iCE40UP5K Device, Top View (from iCE40 UltraPlus Family Data Sheet) + + iCE40UP5K Device, Top View. + +BRAM is frequently used to store data such as buffers, CPU register files, +and large arrays of data. This type of memory is frequently reused as RAM on +many FPGAs. The ICE40UP5K is unusual in that it also has 128 kilobytes of +Single Ported RAM that can be used as memory for a softcore (a term used for +a CPU core running inside an FPGA, to differentiate it from a ‘hard’ - +i.e. fixed chip - implementation). That means that, unlike other FPGAs, +valuable block RAM isn’t taken up by system memory. + +Additionally, the ICE40 family of devices generally supports *warmboot* +capability. This enables us to have multiple designs live on the same +FPGA and tell the FPGA to swap between them. + +As always, this workshop wouldn’t be nearly as easy without the open +source tools that enable us to port it to a lot of different platforms. + +.. _background:about-fomu: + +About Fomu +~~~~~~~~~~ + +Fomu is an ICE40UP5K that fits in your USB port. It contains two +megabytes of SPI flash memory, four edge buttons, and a three-color LED. + +Unlike most other ICE40 projects, Fomu implements its USB in a softcore. +That means that the bitstream that runs on the FPGA must also provide +the ability to communicate over USB. This uses up a lot of storage on +this small FPGA, but it also enables us to have such a tiny form factor, +and lets us do some really cool things with it. + +.. figure:: _static/fomu-block-diagram.png + :align: center + :width: 600px + :alt: Block diagram of Fomu + + Block diagram of Fomu. + +The ICE40UP5K at the heart of Fomu really controls everything, and this +workshop is all about trying to unlock the power of this chip. + +.. NOTE:: + Some figures in this section were extracted from the `iCE40 UltraPlus Family Data Sheet `_. diff --git a/_sources/bootloader.rst.txt b/_sources/bootloader.rst.txt new file mode 100644 index 0000000..c447a06 --- /dev/null +++ b/_sources/bootloader.rst.txt @@ -0,0 +1,93 @@ +.. _bootloader: + +Bootloader +========== + + +.. _bootloader-update: + +Updating the Fomu Bootloader +---------------------------- + + +To update your Fomu, download the appropriate ``-updater`` dfu release from +`foboot `__. + +#. Download the :file:`{board type}-updater-v2.0.3.dfu` file. + + * If you have a ``PVT`` Fomu, download |pvt-updater|. + * If you have a ``Hacker`` Fomu, download |hacker-updater|. + +#. Run :file:`dfu-util -D pvt-updater-{version}.dfu`. +#. Your Fomu will flash rainbow for about five seconds, then reboot and go back + to blinking. +#. To verify it has updated, ``dfu-util -l`` and check the version output. + +.. |pvt-updater| replace:: `pvt-updater-v2.0.3.dfu `__ +.. |hacker-updater| replace:: `hacker-updater-v2.0.3.dfu `__ + +This is an example session for updating a production board: + +.. session:: shell-session + + $ dfu-util -l + dfu-util 0.9 + + Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. + Copyright 2010-2016 Tormod Volden and Stefan Schmidt + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + Found DFU: [1209:5bf0] ver=0101, devnum=19, cfg=1, intf=0, path="1-2", alt=0, name="Fomu PVT running DFU Bootloader v1.9.1", serial="UNKNOWN" + $ wget https://github.com/im-tomu/foboot/releases/download/v2.0.3/pvt-updater-v2.0.3.dfu -O ~/Downloads/pvt-updater-v2.0.3.dfu + --2019-12-27 20:01:16-- https://github.com/im-tomu/foboot/releases/download/v2.0.3/pvt-updater-v2.0.3.dfu + Resolving github.com (github.com)... 140.82.118.3 + Connecting to github.com (github.com)|140.82.118.3|:443... connected. + HTTP request sent, awaiting response... 302 Found + Resolving github-production-release-asset-2e65be.s3.amazonaws.com (github-production-release-asset-2e65be.s3.amazonaws.com)... 52.216.138.107 + Connecting to github-production-release-asset-2e65be.s3.amazonaws.com (github-production-release-asset-2e65be.s3.amazonaws.com)|52.216.138.107|:443... connected. + HTTP request sent, awaiting response... 200 OK + Length: 112844 (110K) [application/octet-stream] + Saving to: ‘~/Downloads/pvt-updater-v2.0.3.dfu’ + + ~/Downloads/pvt-updater-v2.0.3.dfu 100%[=====================================>] 110.20K 332KB/s in 0.3s + + 2019-12-27 20:01:17 (332 KB/s) - ‘~/Downloads/pvt-updater-v2.0.3.dfu’ saved [112844/112844] + + $ dfu-util -D ~/Downloads/pvt-updater-v2.0.3.dfu + dfu-util 0.9 + + Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. + Copyright 2010-2016 Tormod Volden and Stefan Schmidt + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + Match vendor ID from file: 1209 + Match product ID from file: 70b1 + Opening DFU capable USB device... + ID 1209:5bf0 + Run-time device DFU version 0101 + Claiming USB DFU Interface... + Setting Alternate Setting #0 ... + Determining device status: state = dfuIDLE, status = 0 + dfuIDLE, continuing + DFU mode device DFU version 0101 + Device returned transfer size 1024 + Copying data from PC to DFU device + Download [=========================] 100% 112828 bytes + Download done. + state(7) = dfuMANIFEST, status(0) = No error condition is present + state(8) = dfuMANIFEST-WAIT-RESET, status(0) = No error condition is present + Done! + $ sleep 5 + $ dfu-util -l + dfu-util 0.9 + + Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. + Copyright 2010-2016 Tormod Volden and Stefan Schmidt + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + Found DFU: [1209:5bf0] ver=0101, devnum=20, cfg=1, intf=0, path="1-2", alt=0, name="Fomu PVT running DFU Bootloader v2.0.3", serial="UNKNOWN" + $ + diff --git a/_sources/hdl.rst.txt b/_sources/hdl.rst.txt new file mode 100644 index 0000000..b5733fc --- /dev/null +++ b/_sources/hdl.rst.txt @@ -0,0 +1,74 @@ +.. _HDLs: + +Hardware Description Languages +------------------------------ + +The two most common **H**\ ardware **D**\ escription **L**\ anguages are Verilog and VHDL. +As explained in :ref:`background:code-into-gates`, a *synthesis* tool is used for converting +the human readable HDL into a netlist representation. The synthesis tool used in the Fomu +toolchain is called ``yosys``. Once we have the netlist representation, a tool called +``nextpnr`` performs an operation called *place and route* (PnR), which makes it something +that will actually run on the FPGA. This is all done for you using the ``Makefiles`` in the +subdirectories of any of the following examples: :repo:`verilog `, +:repo:`vhdl `, :repo:`mixed-hdl `, or :repo:`migen `. + +.. NOTE:: + ``nextpnr`` is timing-driven. This means that a design will be generated with a given + clock domain guaranteed to perform fast enough, but sometimes it won't optimise further. + When the ``make`` command runs ``nextpnr-ice40`` you will see something similar to the + following: + + :: + + Info: Max frequency for clock 'clk': 73.26 MHz (PASS at 12.00 MHz) + + This output example shows that we could run ``clk`` at up to 73.26 + MHz and it would still be stable (even though we only requested 12.00 + MHz). Note that there is some variation between designs depending on + how the placer and router decided to lay things out, so your exact + frequency numbers might be different from the ones shown in the code + blocks of this documentation. + +.. IMPORTANT:: + As explained in :ref:`background:about-fomu`, Fomu implements its USB in a softcore, and + the bitstream that runs on the FPGA must provide the ability to communicate over USB. + That is a tradeoff for achieving such a tiny board size, which unfortunately makes + it not straightforward to use non-trivial HDL designs. This is because + I/O is very limited, hence, it is challenging to actually *see* whether the designs are + behaving as expected. Ideally, a USB-to-UART core would be provided for users to instantiate + in their HDL designs. Should you be interested in helping achieve it, `let us know! `_ + Meanwhile, :ref:`HDLs:migen` examples provide a working SoC that allows interacting + through USB using a Wishbone Bus. + +.. figure:: _static/ice40-rgb.png + :align: center + :width: 600px + :alt: iCE40 UltraLite and iCE40 UltraPlus RGB Port Level Diagram + + iCE40 UltraLite and iCE40 UltraPlus RGB Port Level Diagram. + +Regardless of the HDL language or higher abstraction programming language used for +describing the design, all the examples in this workshop do use the *hard* RGB block +for driving the LED on the board. It is defined as a Verilog module or VHDL component +named ``SB_RGBA_DRV``. +As shown in the block diagram from the datasheet, the RGB driver has five inputs +(``CURREN``, ``RGBLEDEN``, ``RGB0PWM``, ``RGB1PWM``, and ``RGB2PWM``), +and three outputs (``RGB0``, ``RGB1``, and ``RGB2``). It also has four parameters: +``CURRENT_MODE``, ``RGB0_CURRENT``, ``RGB1_CURRENT``, and ``RGB2_CURRENT``. As a result, +it allows driving the LEDs safely, by specifying the current limit for each of them. +More information on this driver can be found in the `ICE40 LED Driver Usage Guide <_static/reference/FPGA-TN-1288-ICE40LEDDriverUsageGuide.pdf>`_. + +.. ATTENTION:: + Even though it is possible to drive the RGB outputs directly (i.e. without instantiating + ``SB_RGBA_DRV``), it is strongly discouraged, as it might damage the LEDs. + +Languages and generators +======================== + +.. toctree:: + + verilog + vhdl + mixed-hdl + migen + icestudio diff --git a/_sources/help.rst.txt b/_sources/help.rst.txt new file mode 100644 index 0000000..f456d0e --- /dev/null +++ b/_sources/help.rst.txt @@ -0,0 +1,23 @@ +Getting Help +============ + +If you get stuck anywhere in the workshop you can use the following channels to +get help! + +IRC Chat Channel +---------------- + +IRC (`Internet Relay Chat `__) +is old school chat before Slack became popular. You can connect with a wide +range of different clients including web based clients like +`IRCCloud `__. + +* `#tomu channel on irc.freenode.net `__ +* `Freenode WebChat `__ +* `Channel Logs `__ - `Latest `__ + +Mailing Lists +------------- + +* `Announcement mailing list `__ - Low traffic list for announcements. +* `Discussion mailing list `__ - List for discussing development / new features / etc. diff --git a/_sources/icestudio.rst.txt b/_sources/icestudio.rst.txt new file mode 100644 index 0000000..636a153 --- /dev/null +++ b/_sources/icestudio.rst.txt @@ -0,0 +1,115 @@ +Fomu on IceStudio *Nightly* +--------------------------- + +.. IMPORTANT:: Fomu is currently not supported in the stable releases + of IceStudio. Development or `nightly `_ + releases need to be used. + +“Hello world!” - Blink a LED +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The canonical “Hello, world!” of hardware is to blink a LED. The +directory ``icestudio`` contains a Blinky example in ICE format. +Moreover, ``Blinky_BoardTop.ice`` wraps Blinky, showcasing how +to use the Design Under Test (DUT) as a black box. + +Open ``Blinky_BoardTop.ice`` from `Icestudio `_ +and use the buttons at the botton: + +.. image:: _static/icestudio/blinky_steps.png + :width: 600 px + :align: center + :target: https://github.com/juanmard/icestudio + +0. Check that the **selected board** is the Fomu. + + - Click on the button with a 'microchip' icon, and a modal window will open. + - There, select the device (UP5K) in the first dropdown list and the board (Fomu) + in the second list. + +1. Click on the **Verify** button for checking the design. +2. Click on the **Build** button for having the design exported to Verilog, synthesised, + placed, routed and, finally, the bitstream generated. +3. Click on the **Upload** for sending the bitstream to the board. +4. After each of the steps is executed, the corresponding log can be shown through button + **View command output**. + +You should see the rainbow pattern in the Fomu as soon as the *Upload* +step is finished: + +.. image:: _static/icestudio/blinky_video.gif + :width: 600 px + :align: center + :target: https://github.com/juanmard/icestudio + +However, that's just the beginning of the trip... + +Navigation +========== + +You can navigate the hierarchy of the design by double-clicking on the main +block. Go as deep as you want, until you find raw Verilog code. As you +can observe, ICE modules are fancy wrappers around the Verilog code from +``verilog/blink``. + +.. image:: _static/icestudio/blinky.gif + :width: 600 px + :align: center + +Editing submodules is blocked by default, but you can unlock the feature +with the red button at the botton left. Do the modifications you wish, +then save the changes and go back to the top. There is a 'Home' button +at the bottom left for jumping to the root of the design straightaway. +From the top, you can verify, build and upload the design again. + +You can also open or save each of the blocks as an independent project. +For instance, open ``Blinky.ice``, instead of ``Blinky_BoardTop.ice``: + +.. image:: _static/icestudio/blinky_diagram.png + :width: 600 px + :align: center + +Modules are browsable, as shown in the screencast above: + +.. image:: _static/icestudio/clk_buffering.png + :width: 33% +.. image:: _static/icestudio/pwm_generator.png + :width: 33% +.. image:: _static/icestudio/sb_rgba_drv.png + :width: 33% + +Board rules +=========== + +A feature in *IceStudio Nightly* named "*board rules*" allows predefining +assignments for I/O pins. For instance, Fomu needs to disconnect its USB +communication stack when writting raw HDL. Therefore, it is always necessary +to define and set pins *usb_dn*, *usb_dp* and *usb_dp_pu*. Option +*board rules* does so, allowing a cleaner graphical desing. + +Open ``Blinky_BoardTop_rules.ice``, which is the result of using this feature +in the Blinky example. As you see, USB pins need not to be defined explicitly: + +.. image:: _static/icestudio/blinky_board_rules.png + :width: 600 px + :align: center + +Instead, ensure that option *board rules* is activate in the board properties: + +.. image:: _static/icestudio/blinky_board_options.gif + :width: 600 px + :align: center + +As shown in the screencast, you can inpect the specific rules applied to each +pin by using the "*View board rules*" button in the board properties window. + +The same rules can be applied to modules lower in the hierarchy. For example, open +``Blinky_rules.ice`` and compare with ``Blinky_rules.ice`` above: + +.. image:: _static/icestudio/blinky_module_rules.png + :width: 600 px + :align: center + +.. HINT:: Find more info about features of IceStudio (such as collections or + plugins) in the `documentation `_. + diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 0000000..895cd03 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,32 @@ +FPGA Tomu Workshop +================== + +.. image:: _static/logo.png + :align: center + :width: 600px + :alt: Fomu logo + +Hi, I’m `Fomu `_ (FPGA Tomu)! +This workshop covers the basics of Fomu in a top-down approach. We’ll +start out by learning **what Fomu is**, **how to load software** into Fomu, +**how to write software** for Fomu, and finally **how to write hardware** for Fomu. + +FPGAs are complex, weird things, so we’ll take a gentle approach and +start out by treating it like a Python interpreter first, and gradually +peel away layers until we’re writing our own hardware registers. You can +take a break at any time and explore! Stop when you feel the concepts +are too unfamiliar, or plough on and dig deep into the world of +hardware. + +.. toctree:: + :hidden: + :maxdepth: 5 + + requirements/index + background + python + riscv + hdl + renode + bootloader + help diff --git a/_sources/migen.rst.txt b/_sources/migen.rst.txt new file mode 100644 index 0000000..b4dc6aa --- /dev/null +++ b/_sources/migen.rst.txt @@ -0,0 +1,200 @@ +.. _HDLs:migen: + +Migen and LiteX +--------------- + +.. _hello-world---blink-an-led-1: + +“Hello world!” - Blink a LED +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Migen is an HDL embedded in Python. The verilog examples (in directory +``verilog``) can also be written using Migen; an implementation is provided +in directory ``migen``. + +To try them out, go to the ``migen`` directory and execute ``blink.py`` or +``blink-expanded.py`` respectively (before, ensure that you have set +the ``FOMU_REV`` environment variable correctly). This will create a +``build`` directory with a ``top.bin`` file. + +Using ``dfu-util -D build/top.bin``, it can be loaded onto the Fomu and should +work identically as the corresponding verilog example. + +Wishbone Bus Basics +^^^^^^^^^^^^^^^^^^^ + +LiteX provides us with a Wishbone abstraction layer. There really is no +reason we need to include a CPU with our design, but we can still reuse +the USB Wishbone bridge in order to write HDL code. + +We can use ``DummyUsb`` to respond to USB requests and bridge USB to +Wishbone, and rely on LiteX to generate registers and wire them to +hardware signals. We can still use ``wishbone-tool`` to read and write +memory, and with a wishbone bridge we can actually have code running on +our local system that can read and write memory on Fomu. + +Go to the ``litex`` directory and build the design; + +.. session:: shell-session + + $ python3 workshop.py --board $FOMU_REV + lxbuildenv: v2019.8.19.1 (run .\workshop.py --lx-help for help) + lxbuildenv: Skipping git configuration because "skip-git" was found in LX_CONFIGURATION + lxbuildenv: To fetch from git, run .\workshop.py --placer heap --lx-check-git + Warning: Wire top.basesoc_adr has an unprocessed 'init' attribute. + Warning: Wire top.basesoc_bus_wishbone_ack has an unprocessed 'init' attribute. + Warning: Wire top.basesoc_bus_wishbone_dat_r has an unprocessed 'init' attribute. + ... + Info: Device utilisation: + Info: ICESTORM_LC: 1483/ 5280 28% + Info: ICESTORM_RAM: 1/ 30 3% + Info: SB_IO: 4/ 96 4% + Info: SB_GB: 8/ 8 100% + Info: ICESTORM_PLL: 1/ 1 100% + Info: SB_WARMBOOT: 0/ 1 0% + Info: ICESTORM_DSP: 0/ 8 0% + Info: ICESTORM_HFOSC: 0/ 1 0% + Info: ICESTORM_LFOSC: 0/ 1 0% + Info: SB_I2C: 0/ 2 0% + Info: SB_SPI: 0/ 2 0% + Info: IO_I3C: 0/ 2 0% + Info: SB_LEDDA_IP: 0/ 1 0% + Info: SB_RGBA_DRV: 0/ 1 0% + Info: ICESTORM_SPRAM: 4/ 4 100% + ... + Info: [ 55530, 59533) |********+ + Info: [ 59533, 63536) |************************************************+ + Info: [ 63536, 67539) |******************************+ + Info: [ 67539, 71542) |*************+ + Info: [ 71542, 75545) |********************+ + Info: [ 75545, 79548) |************************************************************ + 5 warnings, 0 errors + $ + +Load it onto Fomu: + +.. session:: shell-session + + $ dfu-util -D build/gateware/fomu_$FOMU_REV.bin + dfu-util 0.8 + Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. + Copyright 2010-2014 Tormod Volden and Stefan Schmidt + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to dfu-util@lists.gnumonks.org + + Opening DFU capable USB device... + ID 1209:5bf0 + Run-time device DFU version 0101 + Claiming USB DFU Interface... + Setting Alternate Setting #0 ... + Determining device status: state = dfuIDLE, status = 0 + dfuIDLE, continuing + DFU mode device DFU version 0101 + Device returned transfer size 1024 + Copying data from PC to DFU device + Download [=========================] 100% 104090 bytes + Download done. + state(7) = dfuMANIFEST, status(0) = No error condition is present + state(8) = dfuMANIFEST-WAIT-RESET, status(0) = No error condition is present + Done! + $ + +If you get an error message about missing modules, check you have all +submodules cloned and setup with; + +.. session:: shell-session + + $ git submodule update --recursive --init + $ + +Take a look at ``build/csr.csv``. This describes the various regions +present in our design. You can see +``memory_region,sram,0x10000000,131072``, which indicates the RAM is 128 +kilobytes long and is located at ``0x10000000``, just as when we had a +CPU. You can also see the timer, which is a feature that comes as part +of LiteX. Let’s try reading and writing RAM: + +.. session:: shell-session + + $ wishbone-tool 0x10000000 + Value at 10000000: 0baf801e + $ wishbone-tool 0x10000000 0x98765432 + $ wishbone-tool 0x10000000 + Value at 10000000: 98765432 + $ + +Wishbone Bus Extension +^^^^^^^^^^^^^^^^^^^^^^ + +Aside from that, there’s not much we can *do* with this design. But +there’s a lot of infrastructure there. So let’s add something we can see +(``workshop_rgb.py`` contains the completed example). + +As explained in :ref:`HDLs` the RGB LED driver is defined in Verilog/VHDL +(as ``SB_RGBA_DRV``), but we can import it as a Module into Migen: + +.. code:: python + + class FomuRGB(Module, AutoCSR): + def __init__(self, pads): + self.output = CSRStorage(3) + self.specials += Instance("SB_RGBA_DRV", + i_CURREN = 0b1, + i_RGBLEDEN = 0b1, + i_RGB0PWM = self.output.storage[0], + i_RGB1PWM = self.output.storage[1], + i_RGB2PWM = self.output.storage[2], + o_RGB0 = pads.r, + o_RGB1 = pads.g, + o_RGB2 = pads.b, + p_CURRENT_MODE = "0b1", + p_RGB0_CURRENT = "0b000011", + p_RGB1_CURRENT = "0b000011", + p_RGB2_CURRENT = "0b000011", + ) + +This will instantiate this Verilog block and connect it up. It also +creates a ``CSRStorage`` object that is three bits wide, and assigns it +to ``output``. By having this derive from ``AutoCSR``, the CSRStorage +will have CSR bus accessor methods added to it automatically. Finally, +it wires the pads up to the outputs of the block. + +We can instantiate this block by simply creating a new object and adding +it to ``self.specials`` in our design: + +.. code:: python + + ... + # Add the LED driver block + led_pads = soc.platform.request("rgb_led") + soc.submodules.fomu_rgb = FomuRGB(led_pads) + +Finally, we need to add it to the ``csr_map``: + +.. code:: python + + ... + soc.add_csr("fomu_rgb") + +Now, when we rebuild this design and check ``build/csr.csv`` we can see +our new register: + +.. code:: csv + + csr_register,fomu_rgb_output,0x60003000,1,rw + +We can use ``wishbone-tool`` to write values to ``0x60003000`` (or whatever +your ``build/csr.csv`` says) and see them take effect immediately. + +.. session:: shell-session + + $ wishbone-tool 0x60003000 0x1 # make LED green + $ wishbone-tool 0x60003000 0x2 # make LED red + $ wishbone-tool 0x60003000 0x3 # make LED yellow + $ wishbone-tool 0x60003000 0x4 # make LED blue + $ wishbone-tool 0x60003000 0x5 # make LED teal + $ wishbone-tool 0x60003000 0x6 # make LED pink + $ wishbone-tool 0x60003000 0x7 # make LED white + +You can see that it takes very little code to take a Signal from HDL and +expose it on the Wishbone bus. diff --git a/_sources/mixed-hdl.rst.txt b/_sources/mixed-hdl.rst.txt new file mode 100644 index 0000000..3f1b91e --- /dev/null +++ b/_sources/mixed-hdl.rst.txt @@ -0,0 +1,80 @@ +.. _HDLs:mixed: + +Mixed HDL on Fomu +----------------- + +.. HINT:: It is strongly suggested to get familiar with :ref:`HDLs:Verilog` and :ref:`HDLs:VHDL` examples before + tinkering with these mixed language use cases. + + +“Hello world!” - Blink a LED +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The canonical “Hello, world!” of hardware is to blink a LED. +The directory :repo:`hdl/mixed/blink ` contains a VHDL + Verilog example of a blink project. +This takes the 48 MHz clock and divides it down by a large number so you get an on/off pattern. + +Enter the :repo:`hdl/mixed/blink ` directory and build the demo by using ``make``: + +.. session:: shell-session + + $ make FOMU_REV=$FOMU_REV + ... + Info: Max frequency for clock 'clk_generator.clko': 73.26 MHz (PASS at 12.00 MHz) + + Info: Max delay posedge clk_generator.clko -> : 3.15 ns + + Info: Slack histogram: + Info: legend: * represents 1 endpoint(s) + Info: + represents [1,1) endpoint(s) + Info: [ 69683, 70208) |** + Info: [ 70208, 70733) | + Info: [ 70733, 71258) |** + Info: [ 71258, 71783) |** + Info: [ 71783, 72308) |** + Info: [ 72308, 72833) |** + Info: [ 72833, 73358) | + Info: [ 73358, 73883) |** + Info: [ 73883, 74408) |* + Info: [ 74408, 74933) |** + Info: [ 74933, 75458) |** + Info: [ 75458, 75983) |* + Info: [ 75983, 76508) |* + Info: [ 76508, 77033) |** + Info: [ 77033, 77558) |** + Info: [ 77558, 78083) |* + Info: [ 78083, 78608) | + Info: [ 78608, 79133) |************************* + Info: [ 79133, 79658) |** + Info: [ 79658, 80183) |*** + 22 warnings, 0 errors + icepack blink.asc blink.bit + cp blink.bit blink.dfu + dfu-suffix -v 1209 -p 70b1 -a blink.dfu + dfu-suffix (dfu-util) 0.9 + + Copyright 2011-2012 Stefan Schmidt, 2013-2014 Tormod Volden + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + Suffix successfully added to file + $ + +You can then load ``blink.dfu`` onto Fomu by using ``make load`` or the same ``dfu-util -D`` command we’ve been using so +far. +You should see a blinking pattern of varying color on your Fomu, indicating your bitstream was successfully loaded. + +If you take a closer look at the sources in :repo:`hdl/mixed/blink `, you will find that +modules/components ``blink`` and ``clkgen`` are written both in VHDL and Verilog. +The :repo:`Makefile ` uses ``blink.vhd`` and ``clkgen.v`` by default. +However, any of the following cases produce the same result: + +- ``blink.vhd`` + ``clkgen.v`` +- ``blink.v`` + ``clkgen.vhdl`` +- ``blink.vhd`` + ``clkgen.vhdl`` +- ``blink.v`` + ``clkgen.v`` + +You can modify variables ``VHDL_SYN_FILES`` and ``VERILOG_SYN_FILES`` in the :repo:`Makefile ` +for trying other combinations. +For a better understanding, it is suggested to compare these modules with the single file solutions in +:ref:`HDLs:Verilog` and :ref:`HDLs:VHDL`. diff --git a/_sources/python.rst.txt b/_sources/python.rst.txt new file mode 100644 index 0000000..ebb6b90 --- /dev/null +++ b/_sources/python.rst.txt @@ -0,0 +1,213 @@ +Python on Fomu +============== + +You can load `MicroPython `__, a small Python +implementation, onto Fomu as an ordinary RISC-V binary. A precompiled +binary is located in the root of the Fomu workshop files. + +Use ``dfu-util`` to load it: + +.. session:: shell-session + + $ dfu-util -D micropython-fomu.dfu + Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. + Copyright 2010-2014 Tormod Volden and Stefan Schmidt + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to dfu-util@lists.gnumonks.org + + Opening DFU capable USB device... + ID 1209:5bf0 + Run-time device DFU version 0101 + Claiming USB DFU Interface... + Setting Alternate Setting #0 ... + Determining device status: state = dfuIDLE, status = 0 + dfuIDLE, continuing + DFU mode device DFU version 0101 + Device returned transfer size 1024 + $ + + +.. tabs:: + + .. group-tab:: MacOS X + + If you’re on a macOS machine, use the following command to connect to + the device: + + .. session:: shell-session + + $ screen /dev/cu.usb* + + .. group-tab:: Linux + + If you’re on Linux, use the following command to connect to the device, + it will be called ``ttyACM?``: + + .. session:: shell-session + + $ screen /dev/ttyACM* + + If you are unable to connect you may need ``sudo`` access unless you + grant permission for using the serial device from a non-privileged + account by adding that account to the ``dialout`` group. + + .. WARNING:: + Adding your user to the ``dialout`` group grants full and direct + access to serial ports. + + .. session:: shell-session + + $ ls -alh /dev/ttyACM* + crw-rw---- 1 root dialout 166, 0 Nov 9 21:28 /dev/ttyACM0 + + $ sudo usermod -a -G dialout $USER + + .. WARNING:: + You **must** log out and then log in again for the addition to group + ``dialout`` to take affect. + + .. group-tab:: Windows + + If you’re running a version of Windows earlier than Windows 10, you will + need to install a driver for the serial port. Open Zadag again and + select ``Fomu`` from the dropdown list. Install the driver for + ``USB Serial (CDC)``. + + You can then use a program such as `Tera Term + `__. + + .. session:: powershell + + PS> ttermpro.exe + + In Teraterm hit ``New Connection`` and select the ``Serial Port`` Radio + Button. If it is greyed out you might have to change your USB Port + driver for the Fomu. + + See `Working with Fomu <#working-with-fomu>`__, + above. + +You should be greeted with a MicroPython banner and REPL: + +.. session:: pycon + + MicroPython v1.10-299-g8603316 on 2019-08-19; fomu with vexriscv + >>> + +This is a fully-functioning MicroPython shell. Try running some simple +commands such as ``print()`` and ``hex(9876+1234)``. + +Fomu Python Extensions +---------------------- + +Fomu’s MicroPython binary contains a few extended Python modules that +you can use to interact with some of the hardware. For example, the RGB +LED has some predefined modes you can access. These are all located +under the ``fomu`` module. + +Import the ``fomu`` module and access the ``rgb`` block to change the +mode to the predefined ``error`` mode: + +.. session:: pycon + + >>> import fomu + >>> rgb = fomu.rgb() + >>> rgb.mode("error") + >>> + +We can also look at some information from the SPI flash, such as the SPI +ID. This ID varies between Fomu models, so it can be a good indication +of what kind of Fomu your code is running on: + +.. session:: pycon + + >>> spi = fomu.spi() + >>> hex(spi.id()) + '0xc2152815' + >>> + +Memory-mapped Registers +----------------------- + +If we look at the generated Fomu header files (to be found for instance in +:repo:`riscv-blink `), we can see +many, many memory-mapped registers. For example, the major, minor, and revision +numbers all have registers: + +.. code:: cpp + + #define CSR_VERSION_MAJOR_ADDR 0xe0007000 + #define CSR_VERSION_MINOR_ADDR 0xe0007004 + #define CSR_VERSION_REVISION_ADDR 0xe0007008 + #define CSR_VERSION_MODEL_ADDR 0xe0007028 + +These are special areas of memory that don’t really exist. Instead, they +correspond to hardware. We can read these values using the ``machine`` +class. Read out the major, minor, and revision codes from your Fomu. +They may be different from what you see here: + +.. session:: pycon + + >>> import machine + >>> machine.mem32[0xe0007000] + 2 + >>> machine.mem32[0xe0007004] + 0 + >>> machine.mem32[0xe0007008] + 3 + >>> + +The ``CSR_VERSION_MODEL_ADDR`` contains a single character that +indicates what version of the hardware you have. We can convert this to +a character and print it out. + +If you have a production board you will get ``P`` as shown below; + +.. session:: pycon + + >>> chr(machine.mem32[0xe0007028]) + 'P' + >>> + +If you have a hacker board you will get ``H`` as shown below; + +.. session:: pycon + + >>> chr(machine.mem32[0xe0007028]) + 'H' + >>> + +Memory-mapped RGB driver +~~~~~~~~~~~~~~~~~~~~~~~~ + +The blinking LED is actually a hardware block from Lattice. It has +control registers, and we can modify these registers by writing to +memory in Fomu. Some of these registers control things such as the +timing of the fade in and fade out pulses, and some control the level of +each of the three colors. + +.. image:: _static/ice40-ledd.png + :width: 100% + :alt: Registers of the ICE40 RGB driver + +There is a wrapper in Fomu’s MicroPython that simplifies the process of +writing to these registers. The first argument is the register number, +and the second argument is the value to write. + +For the ``LEDDPWR`` registers, the second argument determines the +brightness, value ranges from 0 to 255. + +Try changing the color of the three LEDs: + +.. session:: pycon + + >>> ADDR_RED_LED_PULSE_WIDTH = 0b0001 # LEDDPWRR + >>> ADDR_GREEN_LED_PULSE_WIDTH = 0b0010 # LEDDPWRG + >>> ADDR_BLUE_LED_PULSE_WIDTH = 0b0011 # LEDDPWRB + >>> rgb.write_raw(ADDR_RED_LED_PULSE_WIDTH, 255) # Red LED fully on + >>> rgb.write_raw(ADDR_GREEN_LED_PULSE_WIDTH, 14) # Green LED mostly off + >>> rgb.write_raw(ADDR_BLUE_LED_PULSE_WIDTH, 1) # Blue LED off + >>> + +The color should change immediately. More information on these registers +can be found in the `ICE40 LED Driver Usage Guide <_static/reference/FPGA-TN-1288-ICE40LEDDriverUsageGuide.pdf>`__. diff --git a/_sources/renode-bridge.rst.txt b/_sources/renode-bridge.rst.txt new file mode 100644 index 0000000..909b1ae --- /dev/null +++ b/_sources/renode-bridge.rst.txt @@ -0,0 +1,167 @@ +Wishbone bridge between Renode and Fomu +======================================= + +This part of the workshop is based on a `Renode, Fomu and Etherbone +bridge +example `__ +from the Renode documentation. + +Just like we can access Fomu peripherals using ``wishbone-tool``, we can +also connect to a physical board from Renode, mapping a part of the +memory space to be accessible via the Etherbone protocol. + +This is a very useful capability as it enables us to potentially +simulate an advanced LiteX SoC system which would not normally fit in +the FPGA (or e.g. take a long time to synthesize), and interface it with +the remaining part of the physical system for I/O. + +Setting up the server +^^^^^^^^^^^^^^^^^^^^^ + +You can use ``wishbone-tool`` to bridge protocols such as USB to Etherbone. +To start the server, run the following command: + +.. session:: shell-session + + $ wishbone-tool -s wishbone + INFO [wishbone_tool::bridge::usb] opened USB device device 006 on bus 001 + +This starts an Etherbone server on ``localhost:1234`` by default. See +``wishbone-tool --help`` to change these settings. + +Now you can start Renode and setup the platform. + +Connecting from Renode +^^^^^^^^^^^^^^^^^^^^^^ + +Run ``renode`` and in the Monitor type: + +:: + + (monitor) include @scripts/complex/fomu/renode_etherbone_fomu.resc + (machine-0) start + Starting emulation... + (machine-0) sysbus LogPeripheralAccess sysbus.led + +You see a new window with a `shell +application `__, +that provides additional commands allowing you to control LEDs on Fomu. + +.. session:: shell-session + + uart:~$ led_toggle + uart:~$ led_breathe + +The ``led_toggle`` command controls the LED by turning it on and off. +``led_breathe`` makes the LED fade slowly in and out, creating a +“breathe” effect. + +The script you loaded configures Renode to log all communication with +Fomu. After issuing some commands in Zephyr’s shell you’ll see: + +:: + + 01:00:31.8276 [DEBUG] led: [cpu: 0x40000988] WriteUInt32 to 0x8 (unknown), value 0x7. + 01:00:31.8279 [DEBUG] led: [cpu: 0x40000990] WriteUInt32 to 0x4 (unknown), value 0x8. + 01:00:31.8290 [DEBUG] led: [cpu: 0x40000998] WriteUInt32 to 0x0 (unknown), value 0xC8. + 01:00:31.8298 [DEBUG] led: [cpu: 0x400009A0] WriteUInt32 to 0x4 (unknown), value 0x9. + 01:00:31.8301 [DEBUG] led: [cpu: 0x400009A8] WriteUInt32 to 0x0 (unknown), value 0xBA. + 01:00:31.8305 [DEBUG] led: [cpu: 0x400009B0] WriteUInt32 to 0x8 (unknown), value 0x6. + 01:00:31.8308 [DEBUG] led: [cpu: 0x400009B4] WriteUInt32 to 0x8 (unknown), value 0x7. + 01:00:31.8311 [DEBUG] led: [cpu: 0x400009BC] WriteUInt32 to 0x4 (unknown), value 0x5. + 01:00:31.8314 [DEBUG] led: [cpu: 0x400009C0] WriteUInt32 to 0x0 (unknown), value 0x0. + 01:00:31.8317 [DEBUG] led: [cpu: 0x400009C4] WriteUInt32 to 0x4 (unknown), value 0x6. + 01:00:31.8321 [DEBUG] led: [cpu: 0x400009C8] WriteUInt32 to 0x0 (unknown), value 0x0. + 01:00:31.8324 [DEBUG] led: [cpu: 0x400009D0] WriteUInt32 to 0x4 (unknown), value 0x2. + 01:00:31.8327 [DEBUG] led: [cpu: 0x400009D4] WriteUInt32 to 0x0 (unknown), value 0x0. + 01:00:31.8331 [DEBUG] led: [cpu: 0x400009DC] WriteUInt32 to 0x4 (unknown), value 0x3. + 01:00:31.8334 [DEBUG] led: [cpu: 0x400009E0] WriteUInt32 to 0x0 (unknown), value 0x0. + 01:00:31.8337 [DEBUG] led: [cpu: 0x400009E8] WriteUInt32 to 0x4 (unknown), value 0x1. + 01:00:31.8341 [DEBUG] led: [cpu: 0x400009F4] WriteUInt32 to 0x0 (unknown), value 0xFF. + 01:00:31.8344 [DEBUG] led: [cpu: 0x40000A08] WriteUInt32 to 0x4 (unknown), value 0xA. + 01:00:31.8347 [DEBUG] led: [cpu: 0x40000A0C] WriteUInt32 to 0x0 (unknown), value 0x0. + 01:00:31.8350 [DEBUG] led: [cpu: 0x40000A14] WriteUInt32 to 0x4 (unknown), value 0xB. + 01:00:31.8353 [DEBUG] led: [cpu: 0x40000A18] WriteUInt32 to 0x0 (unknown), value 0xFF. + +You can interact with Fomu manually, via the Monitor. To do that, you +first need to find the name of the peripheral that serves the connection +to Fomu. + +Type in ``peripherals`` to see a list of all the elements of the +emulated SoC. Look for ``EtherBoneBridge`` entry: + +:: + + (machine-0) peripherals + Available peripherals: + sysbus (SystemBus) + │ + ├── cpu (VexRiscv) + │ Slot: 0 + │ + ├── ddr (MappedMemory) + │ <0x40000000, 0x4FFFFFFF> + │ <0xC0000000, 0xCFFFFFFF> + │ + ├── eth (LiteX_Ethernet) + │ │ <0x60007800, 0x600078FF> + │ │ <0xE0007800, 0xE00078FF> + │ │ <0x30000000, 0x30001FFF> + │ │ <0xB0000000, 0xB0001FFF> + │ │ <0x60007000, 0x600077FF> + │ │ <0xE0007000, 0xE00077FF> + │ │ + │ └── phy (EthernetPhysicalLayer) + │ Address: 0 + │ + ├── flash_mem (MappedMemory) + │ <0x20000000, 0x21FFFFFF> + │ <0xA0000000, 0xA1FFFFFF> + │ + ├── led (EtherBoneBridge) + │ <0xE0006800, 0xE00068FF> + │ + ├── mem (MappedMemory) + │ <0x00000000, 0x0003FFFF> + │ <0x80000000, 0x8003FFFF> + │ + ├── spi (LiteX_SPI_Flash) + │ │ <0x60005000, 0x6000500F> + │ │ <0xE0005000, 0xE000500F> + │ │ + │ └── flash (Micron_MT25Q) + │ + ├── sram (MappedMemory) + │ <0x10000000, 0x1003FFFF> + │ <0x90000000, 0x9003FFFF> + │ + ├── timer0 (LiteX_Timer) + │ <0x60002800, 0x60002843> + │ <0xE0002800, 0xE0002843> + │ + └── uart (LiteX_UART) + <0x60001800, 0x600018FF> + <0xE0001800, 0xE00018FF> + +The device that acts as a connector to Fomu is called ``led`` and is +registered at ``0xE0006800``: + +:: + + ├── led (EtherBoneBridge) + │ <0xE0006800, 0xE00068FF> + +You can either use a full or relative address (via the ``sysbus`` or +``led`` objects, respectively) to communicate with the physical LED +controller: + +:: + + (machine-0) sysbus WriteDoubleWord 0xE0006804 0x1234 # writes 0x1234 to the given address + (machine-0) led WriteDoubleWord 0x4 0x4321 # writes 0x4321 to 0xE0006800 + 0x4 + +Note: the above values are just an example and won’t change the LED +status in any visible way. If you want to enable “breathe” effect +directly from the Monitor, see the necessary sequence in `the +application source +code `__. diff --git a/_sources/renode-starting.rst.txt b/_sources/renode-starting.rst.txt new file mode 100644 index 0000000..5f10d76 --- /dev/null +++ b/_sources/renode-starting.rst.txt @@ -0,0 +1,49 @@ +Getting Renode +============== + +Renode is available for Linux, macOS and Windows. + +On Linux and macOS, you need to have +`Mono `__ installed on your computer. You +should follow the `Mono installation +instructions `__ and +install the ``mono-complete`` package. + +On Windows it’s enough to have a fairly recent `.NET +Framework `__ +installed. + +Then you can either install Renode from `prebuilt +packages `__, or `compile +it +yourself `__. + +Try out Renode quickly with precompiled LiteX demos +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Renode comes with several precompiled demos, which can be used to verify +everything works for you before starting to compile and use your own +software binaries. + +There are three demo scripts available: + +- ``litex_vexriscv_micropython.resc`` +- ``litex_vexriscv_zephyr.resc`` +- ``litex_vexriscv_linux.resc`` + +To run them, start Renode using the ``renode`` command (or ``./renode`` +if you built from sources). + +You will see a terminal window pop up, which is the Renode CLI, called +the Monitor. + +In the Monitor type: + +:: + + (monitor) start @scripts/single-node/ + +(where is one of the above). + +Voila! A UART analyzer window should appear and you should see LiteX +booting the respective binary. diff --git a/_sources/renode-verilator.rst.txt b/_sources/renode-verilator.rst.txt new file mode 100644 index 0000000..ff849cf --- /dev/null +++ b/_sources/renode-verilator.rst.txt @@ -0,0 +1,123 @@ +Renode Co-simulation using Verilator +==================================== + +While connecting Renode to a real FPGA gives you some interesting +possibilities in testing and debugging your gateware together with your +software, there is another usage scenario which is completely hardware +independent - connecting functional simulation of the base system in +Renode with HDL simulation of a part of the system that is under +development. + +To this end, Renode provides an integration layer for Verilator. A +typical setup with Renode + Verilator consists of several components: + +- the ‘verilated’ HDL code itself (e.g. a UART peripheral), +- Verilator integration library, `provided as a plugin to + Renode `__, +- shim layer in C++ connecting the above. + +Currently Renode supports peripherals with the AXILite interface. Keep +in mind that due to the abstract nature of bus operations in Renode, it +doesn’t matter what kind of bus is used on the hardware you want to +simulate. + +In the Renode tree you will find an example with all the elements +already prepared. To run it, start Renode and type: + +:: + + (monitor) include @scripts/single-node/riscv_verilated_uartlite.resc + (UARTLite) start + +This script loads a RISC-V-based system with a verilated UARTLite. You +can verify it by calling: + +:: + + (UARTLite) sysbus WhatPeripheralIsAt 0x70000000 + Antmicro.Renode.Peripherals.Verilated.VerilatedUART + +To inspect the communication with the UART, run: + +:: + + (UARTLite) sysbus LogPeripheralAccess uart + +You will see every read and write to the peripheral displayed in the +Renode log. + +Please note that, despite not being a Renode-native model, the UART is +also capable of displaying an analyzer window. This is because Renode +adds a special support for UART-type peripherals, allowing you not only +to connect bus lines, but also the TX and RX UART lines, to the Renode +infrastructure. + +The HDL and integration layer for this UART peripheral is available on +`Antmicro’s +GitHub `__. + +To compile it manually, you need to have ``ZeroMQ`` (``libzmq3-dev`` on +Debian-like systems) and ``Verilator`` installed in your system. You +also need to provide a full path to the +``src/Plugins/VerilatorPlugin/VerilatorIntegrationLibrary`` directory as +the ``INTEGRATION_DIR`` environment variable. This means that you need +to have a copy of Renode sources to build a verilated peripheral. + +With this set up, simply run ``make``. + +Integration with verilated code +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Renode supports integration with Verilator via AXILite bus, but can be +easily expanded to support other standards as well. + +We’ll briefly take a look on the integration layer implemented in +`sim-main.cpp `__. + +First, the user has to decide on the bus type and peripheral type. These +are provided by the integration library: + +.. code:: c + + #include "src/peripherals/uart.h" + #include "src/buses/axilite.h" + +A bus is a type declaring all the signals and how should they be handled +on each transaction. These signals have to be connected to the signals +in the HDL design: + +:: + + void Init() { + AxiLite* bus = new AxiLite(); + + //================================================= + // Init bus signals + //================================================= + bus->clk = &top->clk; + bus->rst = &top->rst; + bus->awaddr = (unsigned long *)&top->awaddr; + bus->awvalid = &top->awvalid; + bus->awready = &top->awready; + bus->wdata = (unsigned long *)&top->wdata; + bus->wstrb = &top->wstrb; + bus->wvalid = &top->wvalid; + bus->wready = &top->wready; + bus->bresp = &top->bresp; + bus->bvalid = &top->bvalid; + bus->bready = &top->bready; + [...] + +To handle the “external” communication, the user can either use the base +``RenodeAgent`` class of one of its derivatives: for example the +``UART`` type allows you to connect RX and TX signals: + +:: + + // Init peripheral + //================================================= + uart = new UART(bus, &top->txd, &top->rxd, prescaler); + +For more details, see the `verilated uartlite +repository `__. + diff --git a/_sources/renode-zephyr.rst.txt b/_sources/renode-zephyr.rst.txt new file mode 100644 index 0000000..fe14c8b --- /dev/null +++ b/_sources/renode-zephyr.rst.txt @@ -0,0 +1,83 @@ +Running your own Zephyr binary on LiteX/VexRiscv in Renode +========================================================== + +Zephyr is a very capable RTOS governed by a Linux Foundation subproject. +It is very well supported on the RISC-V architecture, as well as in +LiteX. + +Building a Zephyr application +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To install all the dependencies and prepare the environment for building +the Zephyr application follow the official `Zephyr Getting Started +Guide `__ +up to point 4. On Linux you can follow the instructions from the point 5 +on installing the Software Development Toolchain. The python version +in the FOMU toolchain may not work; remove it from your PATH before +attempting to build zephyr. +For other operating +systems, if you followed the instructions from the ``Required Software`` +section of this tutorial, you should have a toolchain in ``PATH``. + +On macOS and Windows you also need to set some additional variables. + +For macOS: + +.. session:: shell-session + + $ export ZEPHYR_TOOLCHAIN_VARIANT=cross-compile + $ export CROSS_COMPILE=riscv64-unknown-elf- + +For Windows: + +:: + + set ZEPHYR_TOOLCHAIN_VARIANT=cross-compile + set CROSS_COMPILE=riscv64-unknown-elf- + +To build the ``shell`` demo application for the LiteX/VexRiscv board run +the following commands on Linux and macOS: + +.. session:: shell-session + + $ cd ~/zephyrproject/zephyr + $ source zephyr-env.sh + $ west build -p auto -b litex_vexriscv samples/subsys/shell/shell_module/ + +And on Windows: + +:: + + cd %HOMEPATH%\zephyrproject\zephyr + zephyr-env.cmd + west build -p auto -b litex_vexriscv samples\subsys\shell\shell_module\ + +The resulting ELF file will be in ``build/zephyr/zephyr.elf``. + +Run the app in Renode +^^^^^^^^^^^^^^^^^^^^^ + +To run the app you just compiled, you basically need to replace the +precomipled demo binary with the one you want, by setting the ``zephyr`` +variable - see below. + +Just like before, start Renode using the ``renode`` command (or +``./renode`` if you built from sources). + +You will see the Monitor, where you should type: + +:: + + (monitor) $zephyr=@/path/to/zephyrproject/zephyr/build/zephyr/zephyr.elf + (monitor) start @scripts/single-node/litex_vexriscv_zephyr.resc + +You should see a new window pop up for the serial port. In it, you +should see the Zephyr interactive shell. + +Debugging the app in Renode +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In general, debugging in Renode is done with GDB just like with a +physical board - you connect to a debug port and execute GDB commands as +usual. For details, see the `Renode debugging +documentation `__. diff --git a/_sources/renode.rst.txt b/_sources/renode.rst.txt new file mode 100644 index 0000000..9d11977 --- /dev/null +++ b/_sources/renode.rst.txt @@ -0,0 +1,35 @@ +Working with LiteX and (co-)simulation with Renode +================================================== + +LiteX used as the soft SoC on Fomu is a very robust and scalable soft +SoC platform, capable of running both bare metal binaries, Zephyr and +even Linux. + +It is also supported in `Renode `__, which is an open +source simulation framework that lets you run unmodified software in a +fully controlled and inspectable environment. Renode is a functional +simulator, which means it aims to mimic the observable behavior of the +hardware instead of trying to be cycle-accurate. + +We will now see how a full-blown Zephyr RTOS can be run on LiteX in +Renode, and then how this simulation can be interfaced with a Fomu for a +useful HW/SW co-development workflow. + +.. tip:: + Apart from RISC-V and LiteX platforms, Renode supports many + other architectures and platforms, as described in the + `documentation `__, + which also includes a user manual and a few tutorials. You can also + take a look at a `Video Tutorials section on Renode’s + website `__. + +Keep in mind that all platforms and configurations in Renode used in +this tutorial are contained in text/config files - you can also explore +Renode’s usage patterns by just inspecting those files for details. + +.. toctree:: + + renode-starting + renode-zephyr + renode-bridge + renode-verilator diff --git a/_sources/requirements/drivers.rst.txt b/_sources/requirements/drivers.rst.txt new file mode 100644 index 0000000..d82b6c0 --- /dev/null +++ b/_sources/requirements/drivers.rst.txt @@ -0,0 +1,100 @@ +.. _required-drivers: + +Required Drivers +================ + +On most systems (such as Windows 10 or newer, or MacOS X), the Fomu board does **not** need any special drivers. + +* On GNU/Linux, you do not need to install any drivers, **however**, you may need + ``sudo`` access unless you :ref:`linux-udev` to grant permission for using the + USB device from a non-privileged account. +* Windows systems **earlier** than Windows 10: you will need to + :ref:`install Zadig drivers `. + +.. _linux-udev: + +Setup udev rules +---------------- + +.. WARNING:: + This set up is for GNU/Linux **only**. Setting up these udev rules grants + permissions for using the USB device from a non-privileged account. + +On GNU/Linux, try running ``dfu-util -l``. If you get an error message like the +following, you should add a ``udev`` rule as to give your user permission to the +USB device. + +.. session:: shell-session + :emphasize-lines: 9 + + $ dfu-util -l + dfu-util 0.9 + + Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. + Copyright 2010-2016 Tormod Volden and Stefan Schmidt + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + dfu-util: Cannot open DFU device 1209:5bf0 + $ + +Steps to set up udev rule +######################### + +#. Add your user to group ``plugdev``: + + .. session:: shell-session + + $ sudo groupadd plugdev + $ sudo usermod -a -G plugdev $USER + + .. WARNING:: + You **must** log out and then log in again for the addition to group ``plugdev`` to take affect. + +#. Use ``id $USER`` and/or ``groups`` to check you are in group ``plugdev``: + + .. session:: shell-session + + $ id $USER + uid=1000(tim) gid=1000(tim) groups=500(plugdev),997(admin) + + $ groups | grep plugdev + tim plugdev admin + +#. Create a file named ``/etc/udev/rules.d/99-fomu.rules`` and add the following. + + .. code:: udev + + SUBSYSTEM=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="5bf0", MODE="0664", GROUP="plugdev" + + .. NOTE:: + You need ``sudo`` privileges for creating this file. + +#. Reload the udev-rules using the following: + + .. session:: shell-session + + $ sudo udevadm control --reload-rules + $ sudo udevadm trigger + + +.. _windows-zadig: + +Installing Zadig Drivers +------------------------ + +.. warning:: + + This set up is only needed for Windows system **earlier** than Windows 10. + +#. Download `Zadig `__. +#. Open Zadig. +#. Under ``Options``, select ``List All Devices``. +#. In the dropdown, select your Fomu; in the field right of the green arrow, + choose the ``WinUSB`` driver; and hit ``Upgrade Driver``. + + .. figure:: ../_static/Zadig-Setup.png + :align: center + :alt: Setup of Zadig for updating USB port driver on Windows earlier than 10 + + Setup of Zadig for updating USB port driver on Windows earlier than 10. diff --git a/_sources/requirements/files.rst.txt b/_sources/requirements/files.rst.txt new file mode 100644 index 0000000..8a283c5 --- /dev/null +++ b/_sources/requirements/files.rst.txt @@ -0,0 +1,46 @@ +.. _required-files: + +Required Files +-------------- + +.. NOTE:: + If you’re attending a workshop that provides USB drives, these files may be + available on the USB drive under the ``Workshop`` directory. + +You will need the Workshop files. They are located in the +`fomu-workshop `_ Github +repository. You can clone it with git, or download +`master.zip `_ | +`master.tar.gz `_. + +.. session:: shell-session + + $ git clone --recurse-submodules https://github.com/im-tomu/fomu-workshop.git + Cloning into 'fomu-workshop'... + remote: Enumerating objects: 140, done. + remote: Counting objects: 100% (140/140), done. + remote: Compressing objects: 100% (93/93), done. + remote: Total 871 (delta 87), reused 94 (delta 46), pack-reused 731 + Receiving objects: 100% (871/871), 6.22 MiB | 1.46 MiB/s, done. + Resolving deltas: 100% (468/468), done. + Submodule 'litex/deps/litedram' (https://github.com/enjoy-digital/litedram.git) registered for path 'litex/deps/litedram' + Submodule 'litex/deps/litescope' (https://github.com/enjoy-digital/litescope.git) registered for path 'litex/deps/litescope' + Submodule 'litex/deps/litex' (https://github.com/enjoy-digital/litex.git) registered for path 'litex/deps/litex' + Submodule 'litex/deps/litex_boards' (https://github.com/litex-hub/litex-boards.git) registered for path 'litex/deps/litex_boards' + Submodule 'litex/deps/migen' (https://github.com/m-labs/migen.git) registered for path 'litex/deps/migen' + Submodule 'litex/deps/pyserial' (https://github.com/pyserial/pyserial.git) registered for path 'litex/deps/pyserial' + Submodule 'litex/deps/valentyusb' (https://github.com/im-tomu/valentyusb.git) registered for path 'litex/deps/valentyusb' + ... + remote: Enumerating objects: 78, done. + remote: Counting objects: 100% (78/78), done. + remote: Compressing objects: 100% (71/71), done. + remote: Total 78 (delta 2), reused 78 (delta 2), pack-reused 0 + Receiving objects: 100% (78/78), 10.88 MiB | 3.86 MiB/s, done. + Resolving deltas: 100% (2/2), done. + Submodule path 'litex/deps/litex/litex/soc/cores/cpu/vexriscv/verilog/ext/VexRiscv/src/test/resources/VexRiscvRegressionData': checked out '539398c1481203a51115b5f1228ea961f0ac9bd3' + Submodule path 'litex/deps/litex/litex/soc/software/compiler_rt': checked out '81fb4f00c2cfe13814765968e09931ffa93b5138' + Submodule path 'litex/deps/litex_boards': checked out '91083f99a8551c3465aaf3d6130268c7f7f24a50' + Submodule path 'litex/deps/migen': checked out '562c0466443f859d6cf0c87a0bb50db094d27cf4' + Submodule path 'litex/deps/pyserial': checked out 'acab9d2c0efb63323faebfd5e3405d77cd4b5617' + Submodule path 'litex/deps/valentyusb': checked out 'b34852eb2e77bd9d04ebc3e6e8454cf6d93a02fb' + $ diff --git a/_sources/requirements/hardware.rst.txt b/_sources/requirements/hardware.rst.txt new file mode 100644 index 0000000..7562506 --- /dev/null +++ b/_sources/requirements/hardware.rst.txt @@ -0,0 +1,79 @@ +.. _required-hardware: + +Required Hardware +################# + +- For this workshop, you will need a `Fomu board `_. +- Aside from that, you need a computer with a USB port that can run the :ref:`required-software`. + +.. NOTE:: + You should not need any special drivers, though on Linux you may need ``sudo`` + access, or special ``udev`` rules for granting permission to use the USB device from a + non-privileged account. + +.. ATTENTION:: + This workshop may be competed with any model of Fomu, though there are some + parts that require you to identify which model you have. See the + :ref:`which-fomu` below. + +.. _which-fomu: + +Which Fomu do I have? +===================== + ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| | Hacker | Production | ++==================+======================================================================+===================================================================+ +| **String** | hacker | pvt | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Bash Command** | ``export FOMU_REV=hacker`` | ``export FOMU_REV=pvt`` | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Front** | |Hacker Hardware Front without case| | |Production Hardware Front without case| | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Back** | |Hacker Hardware Back without case| | |Production Hardware Back without case| | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **In Case** | |Hacker Hardware Back with case| | |Production Hardware Back with case| | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Parts** | |Hacker Hardware Annotated Diagram| | |Production Hardware Annotated Diagram| | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Color** | |Dark Blue| | |Cyan Light Blue| | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Bootloader** | Fomu **Hacker** running DFU Bootloader vX.X.X | Fomu **PVT** running DFU Bootloader vX.X.X | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Description** | These are the original design and cut corners to make it easier to | If you ordered a Fomu from Crowd Supply, this is the model you'll | +| | manufacture. If you received one directly from Tim before 36C3, you | receive. It is small, and fits in a USB port. There is no | +| | probably have one of these. Hacker boards have white silkscreen on | silkscreen on it. This model of Fomu has a large silver crystal | +| | the back. | oscillator that is the tallest component on the board. | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Schematic** | `schematic-hacker.pdf <../_static/reference/schematic-hacker.pdf>`__ | `schematic-pvt.pdf <../_static/reference/schematic-pvt.pdf>`__ | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Received at** | From Tim at 35C3, CCCamp19, HackADay Supercon 2019 | At RISC-V Summit 2019, 36C3, Crowdsupply, Mouser | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ +| **Buy more** | End of Life | `CrowdSupply `__, | ++------------------+----------------------------------------------------------------------+-------------------------------------------------------------------+ + +.. |Dark Blue| raw:: html + + dark blue + +.. |Cyan Light Blue| raw:: html + + cyan / light blue + +.. |Hacker Hardware Front without case| image:: ../_static/hw-hacker-front-bare-small.jpg +.. |Production Hardware Front without case| image:: ../_static/hw-pvt-front-bare-small.jpg +.. |Hacker Hardware Back without case| image:: ../_static/hw-hacker-back-bare-small.jpg +.. |Production Hardware Back without case| image:: ../_static/hw-pvt-back-bare-small.jpg +.. |Hacker Hardware Back with case| image:: ../_static/hw-hacker-back-case-small.jpg +.. |Production Hardware Back with case| image:: ../_static/hw-pvt-back-case-small.jpg +.. |Hacker Hardware Annotated Diagram| image:: ../_static/hw-hacker-annotated.png +.. |Production Hardware Annotated Diagram| image:: ../_static/hw-pvt-annotated.png + + +.. note:: + + There are also Fomu EVT boards which were shipped to early backers of + the Fomu crowd funding campaign. This model of Fomu is about the size + of a credit card. It should have the text “Fomu EVT3” written across + it in white silkscreen. If you have a different EVT board such as + EVT2 or EVT1, they should also work. diff --git a/_sources/requirements/index.rst.txt b/_sources/requirements/index.rst.txt new file mode 100644 index 0000000..fdf21cf --- /dev/null +++ b/_sources/requirements/index.rst.txt @@ -0,0 +1,45 @@ +.. |Foboot Version| replace:: v2.0.3 + +Requirements +############ + +.. NOTE:: + If you are at a workshop, please **install the tools first** and then get + the hardware from your presenter. + +For this workshop you will need: + +- :ref:`The Fomu workshop files ` +- :ref:`The Fomu toolchain ` +- :ref:`A Fomu board ` +- :ref:`Set up drivers ` + +.. WARNING:: + Your Fomu should be running Foboot |Foboot Version| or newer. + + You can see what version you are running by typing ``dfu-util -l`` like so; + + .. session:: shell-session + :emphasize-lines: 9 + + $ dfu-util -l + dfu-util 0.9 + + Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. + Copyright 2010-2016 Tormod Volden and Stefan Schmidt + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + Found DFU: [1209:5bf0] ver=0101, devnum=19, cfg=1, intf=0, path="1-2", alt=0, name="Fomu PVT running DFU Bootloader v2.0.3", serial="UNKNOWN" + $ + + If your Fomu is running an version older than |Foboot Version|, follow the + :ref:`bootloader-update` section. + +.. toctree:: + :maxdepth: 5 + + files + software + hardware + drivers diff --git a/_sources/requirements/software.rst.txt b/_sources/requirements/software.rst.txt new file mode 100644 index 0000000..6347901 --- /dev/null +++ b/_sources/requirements/software.rst.txt @@ -0,0 +1,146 @@ +.. _required-software: + +Required Software +################# + +Fomu requires specialized software. + +.. NOTE:: + If you’re taking this workshop as a class, the toolchains are provided + on the USB disk. + +Static builds of this software are provided for GNU/Linux, macOS, and Windows via +`Fomu Toolchain `__. + +Debian packages are also `available for Raspberry Pi `__. + +Moreover, some examples can be executed using :ref:`required-software:containers`. + +Fomu Toolchain +-------------- + +To install the software, extract it somewhere on your computer, then +open up a terminal window and add that directory to your ``PATH``: + +.. tabs:: + + .. group-tab:: GNU/Linux or MacOS X + + .. session:: shell-session + + $ export PATH=[path-to-toolchain]/bin:$PATH + + .. group-tab:: Windows + + If you use PowerShell as your terminal; + + .. session:: ps1con + + PS> $ENV:PATH = "[path-to-toolchain]\bin;" + $ENV:PATH + + If you use ``cmd.exe`` as your terminal; + + .. session:: doscon + + C:\> PATH=[path-to-toolchain]\bin;%PATH% + +Examples in :ref:`HDLs:VHDL` and :ref:`HDLs:mixed` use `ghdl-yosys-plugin `_, +which looks for standard libraries in the path used when GHDL was configured/built. +Therefore, when the toolchain is extracted to an arbitrary location, ``GHDL_PREFIX`` +needs to be set: + +.. tabs:: + + .. group-tab:: GNU/Linux or MacOS X + + .. session:: shell-session + + $ export GHDL_PREFIX=[path-to-toolchain]/lib/ghdl + + .. group-tab:: Windows + + If you use PowerShell as your terminal; + + .. session:: ps1con + + PS> $ENV:GHDL_PREFIX = "[path-to-toolchain]\lib\ghdl" + + If you use ``cmd.exe`` as your terminal; + + .. session:: doscon + + C:\> GHDL_PREFIX=[path-to-toolchain]\lib\ghdl + +To confirm installation, run the ``yosys`` command and confirm you get +the following output; + +.. code-block:: shell-session + :emphasize-lines: 23 + + $ yosys + + /----------------------------------------------------------------------------\ + | | + | yosys -- Yosys Open SYnthesis Suite | + | | + | Copyright (C) 2012 - 2018 Clifford Wolf | + | | + | Permission to use, copy, modify, and/or distribute this software for any | + | purpose with or without fee is hereby granted, provided that the above | + | copyright notice and this permission notice appear in all copies. | + | | + | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | + | WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | + | MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | + | ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | + | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | + | ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | + | OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | + | | + \----------------------------------------------------------------------------/ + + Yosys 78b30bbb1102047585d1a2eac89b1c7f5ca7344e (git sha1 41d9173, gcc 5.5.0-12ubuntu1~14.04 -fPIC -Os) + + yosys> + +Type ``exit`` to quit ``yosys``. + +.. NOTE:: + See the README of `Fomu Toolchain `_ + for a complete list of the tools included in the toolchain. + +.. _required-software:containers: + +Containers +---------- + +There are several projects which provide ready to use container images including open source EDA tools. +One of those is `hdl/containers `__. +As explained in `hdl.github.io/containers: Usage `__, there are two main +strategies for running EDA tools through containers: + +* All-in-one: a single container is used, which includes all the required tools and dependencies. + `make` and all the tools are executed inside that single container. +* Fine-grained: `make` is executed on the host. For each tool/step, an specific container is used. + +Both strategies are supported by the examples in subdir :repo:`hdl ` of this repository. +Users willing to run those examples with containers need to take care about the following environment variables: + +* `GHDL_PLUGIN_MODULE`: while ghdl-yosys-plugin is built into Yosys in the fomu-toolchain, it is provided as a module in + most containers. + Typically, `GHDL_PLUGIN_MODULE=ghdl` is required. + Some specific containers might require `GHDL_PLUGIN_MODULE=path/to/ghdl-plugin-name.so`. +* `CONTAINER_ENGINE`: in order to enable the fine-grained approach, `CONTAINER_ENGINE` needs to contain the CLI tool + name of a container engine, such as `docker` or `podman`. + This variable needs to be unset for the all-in-one approach. + In that case, the build is agnostic to the fact that everything is being done inside a container. + + .. NOTE:: + By default, container images defined in :repo:`hdl/container.mk ` are used when + `CONTAINER_ENGINE` is set. + It's up to the users to customise that file in order to use different container images, or for executing some of the + tools locally. + +.. TIP:: + Find both approaches (and environment variables) used in the CI workflow + (:repo:`.github/workflows/test.yml <.github/workflows/test.yml>`) of this repository. diff --git a/_sources/riscv.rst.txt b/_sources/riscv.rst.txt new file mode 100644 index 0000000..bfc1f28 --- /dev/null +++ b/_sources/riscv.rst.txt @@ -0,0 +1,351 @@ +Fomu as a CPU +------------- + +The MicroPython interface is simply a RISC-V program. It interacts with +the RISC-V softcore inside Fomu by reading and writing memory directly. + +The CPU in Fomu is built on LiteX, which places every device on a +Wishbone bus. This is a 32-bit internal bus that maps peripherals into +memory. + +.. image:: _static/litex-design.png + :width: 100% + :alt: Fomu peripherals on the Wishbone bus + +If you look at the diagram above, you can see that everything in the +system is on the Wishbone bus. The CPU is a bus master, and can initiate +reads and writes. The system’s RAM is on the wishbone bus, and is +currently located at address ``0x10000000``. The boot ROM is also on the +bus, and is located at ``0x00000000``. There is also SPI flash which is +memory-mapped, so when you load your program onto the SPI flash it shows +up on the Wishbone bus at offset ``0x20040000``. + +The Configuration and Status Registers (CSRs) all show up at offset +``0xe0000000``. These are the registers we were accessing from Python. +Just like before, these special memory addresses correspond to control +values. + +You’ll notice a “Bridge” in the diagram above. This is an optional +feature that we ship by default on Fomu. It bridges the Wishbone bus to +another device. In our case, it makes Wishbone available over USB. + +.. image:: _static/wishbone-usb-debug-bridge.png + :width: 100% + :alt: Wishbone USB debug bridge interface + +The above image shows the structure of a special USB packet we can +generate to access the Wishbone bus from a host PC. It lets us do two +things: Read a 32-bit value from Wishbone, or write a 32-bit value to +Wishbone. These two primitives give us complete control over Fomu. + +Recall these definitions from earlier: + +.. literalinclude:: ../riscv-blink/include/generated/csr.h + :language: cpp + :lines: 668,674,680,712 + +We can use the ``wishbone-tool`` program to read these values directly +out of Fomu: + +.. session:: shell-session + + $ wishbone-tool 0xe0007000 + Value at e0007000: 00000002 + $ wishbone-tool 0xe0007004 + Value at e0007004: 00000000 + $ wishbone-tool 0xe0007008 + Value at e0007008: 00000003 + $ + +The three values correspond to the version number of the board at time +of writing: v2.0.3. + +We can also read and write directly to memory. Recall that memory is +mapped to address ``0x10000000``. Let’s write a test value there and try +to read it back. + +.. session:: shell-session + + $ wishbone-tool 0x10000000 + Value at 10000000: 00000005 + $ wishbone-tool 0x10000000 0x12345678 + $ wishbone-tool 0x10000000 + Value at 10000000: 0x12345678 + +We can see that the value got stored in memory, just like we thought it +would. The bridge is working, and we have access to Fomu over USB. + +Interacting with the LED Directly +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Recall the LED block from Python. We used ``rgb.write_raw()`` to write +values to the LED block. Because of how the LED block is implemented, we +need to actually make two writes to the Wishbone bus in order to write +one value to the LED block. The first write sets the address, and the +second write sends the actual data. + +The registers for the LED block are defined as: + +.. code:: cpp + + #define CSR_RGB_DAT_ADDR 0xe0006800 + #define CSR_RGB_ADDR_ADDR 0xe0006804 + +Let’s change the red color to the maximum value. To do that, we’ll write +a ``1`` to the address register, and ``0xff`` to the data register: + +.. session:: shell-session + + $ wishbone-tool 0xe0006804 1 + $ wishbone-tool 0xe0006800 0xff + $ + +We can see that the LED immediately changed its behavior. Try playing +around with various values to see what combinations you can come up +with! + +You can reset Fomu by writing a special value to the ``CSR_REBOOT_CTRL`` +register at ``0xe0006000L``. All writes to this register must start with +``0xac``, to ensure random values aren’t written. We can reboot Fomu by +simply writing this value: + +.. session:: shell-session + + $ wishbone-tool 0xe0006000 0xac + INFO [wishbone_tool::usb_bridge] opened USB device device 007 on bus 001 + INFO [wishbone_tool::usb_bridge] waiting for target device + ERROR [wishbone_tool] server error: BridgeError(USBError(Pipe)) + $ + +We can see that ``wishbone-tool`` has crashed with an error of +``USBError(Pipe)``, because the USB device went away as we were talking +to it. This is expected behavior. Fomu should be back to its normal +color and blink rate now. + +Compiling RISC-V Code +~~~~~~~~~~~~~~~~~~~~~ + +Of course, Fomu’s softcore is a full CPU, so we can write C code for it. +Go to the ``riscv-blink/`` directory and run ``make``. This will +generate ``riscv-blink.dfu``, which we can load onto Fomu. + +.. session:: shell-session + + $ make + CC ./src/main.c main.o + CC ./src/rgb.c rgb.o + CC ./src/time.c time.o + AS ./src/crt0-vexriscv.S crt0-vexriscv.o + LD riscv-blink.elf + OBJCOPY riscv-blink.bin + IHEX riscv-blink.ihex + DFU riscv-blink.dfu + $ dfu-util -D riscv-blink.dfu + Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. + Copyright 2010-2014 Tormod Volden and Stefan Schmidt + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to dfu-util@lists.gnumonks.org + + Match vendor ID from file: 1209 + Match product ID from file: 5bf0 + Opening DFU capable USB device... + ID 1209:5bf0 + Run-time device DFU version 0101 + Claiming USB DFU Interface... + Setting Alternate Setting #0 ... + Determining device status: state = dfuIDLE, status = 0 + dfuIDLE, continuing + DFU mode device DFU version 0101 + Device returned transfer size 1024 + Copying data from PC to DFU device + Download [====== ] 24% 804 bytes + $ + +This will load the binary onto Fomu and start it immediately. The LED +should be blinking quickly in a rainbow pattern. Congratulations! You’ve +compiled and loaded a RISC-V program onto a softcore. + +Let’s modify the program by increasing the fade rate so much that it +appears solid. First, reboot Fomu by running +``wishbone-tool 0xe0006000 0xac``. Next, apply the following patch to +``src/main.c``: + +.. code:: diff + + --- a/riscv-blink/src/main.c + +++ b/riscv-blink/src/main.c + @@ -46,6 +46,7 @@ int main(void) { + usb_init(); + rgb_init(); + usb_connect(); + + rgb_write((100000/64000)-1, LEDDBR); + int i = 0; + while (1) { + color_wheel(i++); + +What this does is increase the LED blink rate from 250 Hz to a much +higher value. Compile this and load it again with +``dfu-util -D riscv-blink.bin``. The blink rate should appear solid, +because it’s blinking too quickly to see. + +Debugging RISC-V Code +~~~~~~~~~~~~~~~~~~~~~ + +Because we have ``peek`` and ``poke``, and because the USB bridge is a +bus master, we can actually halt (and reset!) the CPU over the USB +bridge. We can go even further and attach a full debugger to it! + +To start with, run ``wishbone-tool -s gdb``: + +.. session:: shell-session + + $ wishbone-tool -s gdb + INFO [wishbone_tool::usb_bridge] opened USB device device 008 on bus 001 + INFO [wishbone_tool::server] accepting connections on 127.0.0.1:3333 + $ + +In a second window, run gdb on ``riscv-blink.elf``: + +.. session:: shell-session + + $ riscv64-unknown-elf-gdb riscv-blink.elf -ex 'target remote localhost:3333' + GNU gdb (GDB) 8.2.90.20190228-git + Copyright (C) 2019 Free Software Foundation, Inc. + License GPLv3+: GNU GPL version 3 or later + This is free software: you are free to change and redistribute it. + There is NO WARRANTY, to the extent permitted by law. + Type "show copying" and "show warranty" for details. + This GDB was configured as "--host=x86_64-w64-mingw32 --target=riscv64-unknown-elf". + Type "show configuration" for configuration details. + For bug reporting instructions, please see: + . + Find the GDB manual and other documentation resources online at: + . + + For help, type "help". + Type "apropos word" to search for commands related to "word"... + Reading symbols from .\riscv-blink.elf... + Remote debugging using localhost:1234 + csr_writel (addr=3758106660, value=1) at ./include/hw/common.h:41 + 41 *((volatile uint32_t *)addr) = value; + (gdb) + +If we run ``bt`` we can get a backtrace, and chances are that we landed +in an ``msleep`` function: + +.. code:: gdb + + (gdb) bt + #0 0x2004014c in csr_readl (addr=3758106664) at ./include/hw/common.h:46 + #1 timer0_value_read () at ./include/generated/csr.h:242 + #2 0x200401dc in msleep (ms=ms@entry=80) at ./include/hw/common.h:41 + #3 0x20040074 in main () at ./src/main.c:45 + (gdb) + +We can insert breakpoints, step, continue execution, and generally debug +the entire system. We can even reset the program by running +``mon reset``. + + +Using Rust +~~~~~~~~~~ + +As an alternative to C, the `Rust Language `_ can be used to write software for the Fomu softcore. +To install Rust, follow the instructions on https://rustup.rs/. After installing Rust, we can install support for RISCV +targets using ``rustup``: + +.. session:: shell-session + + $ rustup target add riscv32i-unknown-none-elf + info: downloading component 'rust-std' for 'riscv32i-unknown-none-elf' + 4.5 MiB / 4.5 MiB (100 %) 2.1 MiB/s in 2s ETA: 0s + info: installing component 'rust-std' for 'riscv32i-unknown-none-elf' + +A Rust version of the C program used above is located in the ``riscv-rust-blink`` directory. Change into that directory, +and build it using ``cargo``, the Rust package manager: + +.. session:: shell-session + + $ cargo build --release + Compiling semver-parser v0.7.0 + Compiling proc-macro2 v0.4.30 + Compiling unicode-xid v0.1.0 + Compiling rand_core v0.4.2 + Compiling vexriscv v0.0.1 + Compiling syn v0.15.44 + Compiling bit_field v0.9.0 + Compiling fomu-rt v0.0.3 + Compiling r0 v0.2.2 + Compiling vcell v0.1.2 + Compiling panic-halt v0.2.0 + Compiling rand_core v0.3.1 + Compiling semver v0.9.0 + Compiling rand v0.5.6 + Compiling rustc_version v0.2.3 + Compiling bare-metal v0.2.4 + Compiling quote v0.6.13 + Compiling fomu-pac v0.0.1 + Compiling riscv-rt-macros v0.1.6 + Compiling riscv-rust-blink v0.1.0 (/home/dominik/Coding/fomu-workshop/riscv-rust-blink) + Finished release [optimized] target(s) in 29.39s + +The resulting binary is located in the target subfolder: ``target/riscv32i-unknown-none-elf/release/riscv-rust-blink``. It can +be flashed using the ``flash.sh`` script, also located in the ``riscv-rust-blink`` folder: + +.. session:: shell-session + + $ ./flash.sh + dfu-suffix (dfu-util) 0.9 + + Copyright 2011-2012 Stefan Schmidt, 2013-2014 Tormod Volden + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + Suffix successfully added to file + dfu-util 0.9 + + Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc. + Copyright 2010-2019 Tormod Volden and Stefan Schmidt + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + Match vendor ID from file: 1209 + Match product ID from file: 70b1 + Opening DFU capable USB device... + ID 1209:5bf0 + Run-time device DFU version 0101 + Claiming USB DFU Interface... + Setting Alternate Setting #0 ... + Determining device status: state = dfuIDLE, status = 0 + dfuIDLE, continuing + DFU mode device DFU version 0101 + Device returned transfer size 1024 + Copying data from PC to DFU device + Download [=========================] 100% 3012 bytes + Download done. + state(7) = dfuMANIFEST, status(0) = No error condition is present + state(8) = dfuMANIFEST-WAIT-RESET, status(0) = No error condition is present + Done! + + +Now the Fomu should blink in the same rainbow pattern as before. + + +.. warning:: + + The Rust example currently does not support the USB functionality. After programming the example, we will not be able to + acces the Fomu over USB anymore. To enable USB again, we have to reset the Fomu by removing it from the USB port and + plugging it in again. + + +Further RISC-V experiments +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The `TinyUSB `__ USB stack supports Fomu. To get started with it, you might compile the mass storage example it provides. To do so, follow these steps: + +* Clone the TinyUSB git repository: ``git clone https://github.com/hathach/tinyusb`` (you don't need to initialize the subrepositories) +* Change to ``tinyusb/examples/device/cdc_msc`` +* Compile: ``make BOARD=fomu CROSS_COMPILE=riscv64-unknown-elf-`` +* Load it onto the Fomu: ``dfu-util -D _build/fomu/cdc_msc.bin`` + +Fomu should now appear as a USB storage device containing a README. diff --git a/_sources/verilog.rst.txt b/_sources/verilog.rst.txt new file mode 100644 index 0000000..7334c75 --- /dev/null +++ b/_sources/verilog.rst.txt @@ -0,0 +1,71 @@ +.. _HDLs:Verilog: + +Verilog on Fomu +--------------- + +“Hello world!” - Blink a LED +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The canonical “Hello, world!” of hardware is to blink a LED. +The directory :repo:`hdl/verilog/blink ` contains a Verilog example of a blink project. +This takes the 48 MHz clock and divides it down by a large number so you get an on/off pattern. + +Enter the :repo:`hdl/verilog/blink ` directory and build the demo by using ``make``: + +**Make sure you set the** ``FOMU_REV`` **value to match your hardware!** See :ref:`required-hardware`. + +.. session:: shell-session + + $ make FOMU_REV=$FOMU_REV + ... + Info: Max frequency for clock 'clk': 73.26 MHz (PASS at 12.00 MHz) + + Info: Max delay posedge clk -> : 3.15 ns + + Info: Slack histogram: + Info: legend: * represents 1 endpoint(s) + Info: + represents [1,1) endpoint(s) + Info: [ 69683, 70208) |** + Info: [ 70208, 70733) | + Info: [ 70733, 71258) |** + Info: [ 71258, 71783) |** + Info: [ 71783, 72308) |** + Info: [ 72308, 72833) |** + Info: [ 72833, 73358) | + Info: [ 73358, 73883) |** + Info: [ 73883, 74408) |* + Info: [ 74408, 74933) |** + Info: [ 74933, 75458) |** + Info: [ 75458, 75983) |* + Info: [ 75983, 76508) |* + Info: [ 76508, 77033) |** + Info: [ 77033, 77558) |** + Info: [ 77558, 78083) |* + Info: [ 78083, 78608) | + Info: [ 78608, 79133) |************************* + Info: [ 79133, 79658) |** + Info: [ 79658, 80183) |*** + 22 warnings, 0 errors + icepack blink.asc blink.bit + cp blink.bit blink.dfu + dfu-suffix -v 1209 -p 70b1 -a blink.dfu + dfu-suffix (dfu-util) 0.9 + + Copyright 2011-2012 Stefan Schmidt, 2013-2014 Tormod Volden + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + Suffix successfully added to file + $ + +You can then load ``blink.dfu`` onto Fomu by using the same ``dfu-util -D`` command we’ve been using so far. +You should see a blinking pattern of varying color on your Fomu, indicating your bitstream was successfully loaded. + + +Reading Input +^^^^^^^^^^^^^ + +There is another small example in :repo:`hdl/verilog/blink-expanded ` which shows how to read +out some given pins. +Build and flash it like described above and see if you can enable the blue and red LED by shorting pins 1+2 or 3+4 on +your Fomu (the pins are the exposed contacts sticking out of the USB port). diff --git a/_sources/vhdl.rst.txt b/_sources/vhdl.rst.txt new file mode 100644 index 0000000..f6ce08e --- /dev/null +++ b/_sources/vhdl.rst.txt @@ -0,0 +1,68 @@ +.. _HDLs:VHDL: + +VHDL on Fomu +------------ + +.. HINT:: Component declarations for instantiating hard cores (such as the ones in + :repo:`hdl/sb_ice40_components.vhd `) are found in the installation of + `iCEcube2 `_. + + +“Hello world!” - Blink a LED +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The canonical “Hello, world!” of hardware is to blink a LED. +The directory :repo:`hdl/vhdl/blink ` contains a VHDL example of a blink project. +This takes the 48 MHz clock and divides it down by a large number so you get an on/off pattern. + +Enter the :repo:`hdl/vhdl/blink ` directory and build the demo by using ``make``: + +**Make sure you set the** ``FOMU_REV`` **value to match your hardware!** See :ref:`required-hardware`. + +.. session:: shell-session + + $ make FOMU_REV=$FOMU_REV + ... + Info: Max frequency for clock 'clk': 70.39 MHz (PASS at 12.00 MHz) + + Info: Max delay posedge clk -> : 3.15 ns + + Info: Slack histogram: + Info: legend: * represents 1 endpoint(s) + Info: + represents [1,1) endpoint(s) + Info: [ 69127, 69680) |** + Info: [ 69680, 70233) |** + Info: [ 70233, 70786) | + Info: [ 70786, 71339) |** + Info: [ 71339, 71892) |** + Info: [ 71892, 72445) |** + Info: [ 72445, 72998) |** + Info: [ 72998, 73551) | + Info: [ 73551, 74104) |** + Info: [ 74104, 74657) |** + Info: [ 74657, 75210) |** + Info: [ 75210, 75763) |** + Info: [ 75763, 76316) | + Info: [ 76316, 76869) |** + Info: [ 76869, 77422) |** + Info: [ 77422, 77975) |** + Info: [ 77975, 78528) | + Info: [ 78528, 79081) |*************************** + Info: [ 79081, 79634) |** + Info: [ 79634, 80187) |*** + 22 warnings, 0 errors + docker run --rm -v //t/fomu/fomu-workshop/hdl/vhdl/blink/../..://src -w //src/hdl/vhdl/blink ghdl/synth:icestorm icepack blink.asc blink.bit + cp blink.bit blink.dfu + dfu-suffix -v 1209 -p 70b1 -a blink.dfu + dfu-suffix (dfu-util) 0.9 + + Copyright 2011-2012 Stefan Schmidt, 2013-2014 Tormod Volden + This program is Free Software and has ABSOLUTELY NO WARRANTY + Please report bugs to http://sourceforge.net/p/dfu-util/tickets/ + + Suffix successfully added to file + $ + +You can then load ``blink.dfu`` onto Fomu by using ``make load`` or the same ``dfu-util -D`` command we’ve been using so +far. +You should see a blinking pattern of varying color on your Fomu, indicating your bitstream was successfully loaded. diff --git a/_static/Zadig-Setup.png b/_static/Zadig-Setup.png new file mode 100644 index 0000000..f8682bc Binary files /dev/null and b/_static/Zadig-Setup.png differ diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8549469 --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,134 @@ +/* + * _sphinx_javascript_frameworks_compat.js + * ~~~~~~~~~~ + * + * Compatability shim for jQuery and underscores.js. + * + * WILL BE REMOVED IN Sphinx 6.0 + * xref RemovedInSphinx60Warning + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 0000000..4e9a9f1 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,900 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 0000000..527b876 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 0000000..b57ae3b --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/fomu-block-diagram.png b/_static/fomu-block-diagram.png new file mode 100644 index 0000000..9087053 Binary files /dev/null and b/_static/fomu-block-diagram.png differ diff --git a/_static/fomu.drawio b/_static/fomu.drawio new file mode 100644 index 0000000..aab8fcb --- /dev/null +++ b/_static/fomu.drawio @@ -0,0 +1 @@ +5Vpbd6o4FP41PtrFLVweWy+nnalrnOOcmfYRISpLBCdiq/31k0CCIUGlFUU7dK2W7ISd5Mv3ZW9CW3pnsfmB3OVsEPswbGmKv2np3ZamAdXCv4lhmxl028gMUxT4mUndGUbBB6RGhVrXgQ9XhYZJHIdJsCwavTiKoJcUbC5C8Xux2SQOi70u3SmUDCPPDWXrP4GfzOgsdEXZVTzCYDqjXRumTR9ZuKw1bbqauX78zpn0XkvvoDhOsrvFpgNDAh4DJnuuv6c2HxmCUVLlgYX398h86T22+72n3+YDL5g/fLS1zMubG67pjFuaGWJ/D2N8MyU3T52eofwagt9ZDe4ir8xbI9HiB29k0smWQmn+uyYzfUjgJmm7YTCNWvo9bhHCSYL/pE/i9YmS9iplAakDy83uQbGD1dKNjg8DD7asITanA6x/zKpyaNCkcWkXlbyomo3r5qTX0fDn/YCbTeb4OiZZBviJEzfZvB8qTfualrx+NIBmY6krz53VbSFx2qwJ9VWzPQ6Ij+5o2Bj5D+5KVed40EnpNlZlklqhaw3F68iHZP8nM3mfBQkcLV2P1L7jcI1ts2QR4pJKBhiEYScOY5Q+q/sutCce4W+C4jnkakzPhuNJ3t8bRBi9vUFJzUMdzhFgvIAJ2uImG5YP0OhI8wOVld930VZlEXTGBVqVRWCXRvhp7nsXA/ENDYOfCIm6FBI7aLtK3FBeHYNwcvD4USvwk8lE80qB982xCcx6gNcqAG+X4G6cC3ZDgv3P0fAJW/qhu5rJ2JPGg5opD6DtG2XI29pYN8+EfA5pU8gDCXkD703KX/Hamy1df1UvuwH5Kd1W0ovulJw9u2rabgAoYJ/n8U1hb0rY//xBQs5zr1sr7FDF5LbKYHdMS3drorZhXBm8lgTvrxGBd7kOw/Wy5m0bmnu2bcsZK0o9CAPtyjYPuxzhOoG1PVgO7NgGBjgTsI3HQ3YCUng1F2BdzdwluZ2EcHNPTjswFjDy6W3Xw5FzFWTQuSiRzRzoGCa0faELlBZeSeEOsGJ3w1d2t3mJndporB+uDDdB8sJ6wPeZT1azc0kKW64whCjAMEJEbQIllPQiTKKLA1jf7JBGpWMrlDP8oC8d+QgkwRjHa+TBA6tD1wJ3OYXJMXnIpONIBUpIxWwIhm4SvBWHW8Y02sMwDtK3D8ZpReC0SNZsmvQp/uhIcKQ5RUeGKjjKcJAcpcTPp32CFtSTtRDFERSFMA5jb75HBuqdooCiFCzHqUUMSkEM4LAYiH9RDanjfkAwZN1ypX1aOa4PXk01asWqqBWtUa2oQmAVKV5VKwAccXRurZQd6Z5XK1yUeC3o4iSV5Mp45QJIuUq+JojGgoddURBWo4LQBR5bXxSE4eCldLir6NZ07hxldwnjPLdY5MOesweWOvOrSxB/J0iyOoU8TtE/nck1kIPpTcpIt4QcDHw1rgg5mCY6OrdU5AO6z0qFyeJ/oJWCTuxbUInRqEpEcn81+xLldvHsSz5MrUUlNMqUZ1+KrfNCUW9HJoUcTzksk7I3oao6aYrXhvAGrotfrSrz2sFpEtibRNkXZrl8bH3utOkWWX6TjLVrYqxhOXcWz1i9WcrKnwKGz88Saz93UB1HjFPppxXcMIimLfZOuu+zucCuTqePr9Z5Pqc7NB5x5Cn/mr6fJyedYrONgYP96Y/TUC/CLK7BNaCuARl19aKoy6+16QdFpYvwzoC+G+sNc89RBYe/cVH85Xelb8h6BxxF/bKsl3Pv74e6IR0DNL3XyLng90e9LK7WhDou7v4nPMt+dv9Zr/f+Aw== \ No newline at end of file diff --git a/_static/font/NotoSansCJKjp/LICENSE_OFL.txt b/_static/font/NotoSansCJKjp/LICENSE_OFL.txt new file mode 100644 index 0000000..d952d62 --- /dev/null +++ b/_static/font/NotoSansCJKjp/LICENSE_OFL.txt @@ -0,0 +1,92 @@ +This Font Software is licensed under the SIL Open Font License, +Version 1.1. + +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font +creation efforts of academic and linguistic communities, and to +provide a free and open framework in which fonts may be shared and +improved in partnership with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply to +any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software +components as distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, +deleting, or substituting -- in part or in whole -- any of the +components of the Original Version, by changing formats or by porting +the Font Software to a new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, +modify, redistribute, and sell modified and unmodified copies of the +Font Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, in +Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the +corresponding Copyright Holder. This restriction only applies to the +primary font name as presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created using +the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Black.ttf b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Black.ttf new file mode 100644 index 0000000..f70b497 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Black.ttf differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Black.woff b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Black.woff new file mode 100644 index 0000000..dd2de7d Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Black.woff differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Black.woff2 b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Black.woff2 new file mode 100644 index 0000000..95aed7e Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Black.woff2 differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Bold.ttf b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Bold.ttf new file mode 100644 index 0000000..bbf0bac Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Bold.ttf differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Bold.woff b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Bold.woff new file mode 100644 index 0000000..a907430 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Bold.woff differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Bold.woff2 b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Bold.woff2 new file mode 100644 index 0000000..4a31392 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Bold.woff2 differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-DemiLight.ttf b/_static/font/NotoSansCJKjp/NotoSansCJKjp-DemiLight.ttf new file mode 100644 index 0000000..2e29a0c Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-DemiLight.ttf differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-DemiLight.woff b/_static/font/NotoSansCJKjp/NotoSansCJKjp-DemiLight.woff new file mode 100644 index 0000000..939bcd9 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-DemiLight.woff differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-DemiLight.woff2 b/_static/font/NotoSansCJKjp/NotoSansCJKjp-DemiLight.woff2 new file mode 100644 index 0000000..af3a459 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-DemiLight.woff2 differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Light.ttf b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Light.ttf new file mode 100644 index 0000000..f63e630 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Light.ttf differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Light.woff b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Light.woff new file mode 100644 index 0000000..e5c7a33 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Light.woff differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Light.woff2 b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Light.woff2 new file mode 100644 index 0000000..29d3573 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Light.woff2 differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Medium.ttf b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Medium.ttf new file mode 100644 index 0000000..de69781 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Medium.ttf differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Medium.woff b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Medium.woff new file mode 100644 index 0000000..4403ae5 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Medium.woff differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Medium.woff2 b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Medium.woff2 new file mode 100644 index 0000000..d377a38 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Medium.woff2 differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Regular.ttf b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Regular.ttf new file mode 100644 index 0000000..11c367b Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Regular.ttf differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Regular.woff b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Regular.woff new file mode 100644 index 0000000..8fbb52a Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Regular.woff differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Regular.woff2 b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Regular.woff2 new file mode 100644 index 0000000..f67d581 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Regular.woff2 differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Thin.ttf b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Thin.ttf new file mode 100644 index 0000000..295c2c3 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Thin.ttf differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Thin.woff b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Thin.woff new file mode 100644 index 0000000..afa02dd Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Thin.woff differ diff --git a/_static/font/NotoSansCJKjp/NotoSansCJKjp-Thin.woff2 b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Thin.woff2 new file mode 100644 index 0000000..3bf47a3 Binary files /dev/null and b/_static/font/NotoSansCJKjp/NotoSansCJKjp-Thin.woff2 differ diff --git a/_static/font/Roboto/Roboto-Regular.eot b/_static/font/Roboto/Roboto-Regular.eot new file mode 100644 index 0000000..cd7a772 Binary files /dev/null and b/_static/font/Roboto/Roboto-Regular.eot differ diff --git a/_static/font/Roboto/Roboto-Regular.ttf b/_static/font/Roboto/Roboto-Regular.ttf new file mode 100644 index 0000000..0e58508 Binary files /dev/null and b/_static/font/Roboto/Roboto-Regular.ttf differ diff --git a/_static/font/Roboto/Roboto-Regular.woff b/_static/font/Roboto/Roboto-Regular.woff new file mode 100644 index 0000000..5a267b0 Binary files /dev/null and b/_static/font/Roboto/Roboto-Regular.woff differ diff --git a/_static/font/Roboto/Roboto-Regular.woff2 b/_static/font/Roboto/Roboto-Regular.woff2 new file mode 100644 index 0000000..91d210a Binary files /dev/null and b/_static/font/Roboto/Roboto-Regular.woff2 differ diff --git a/_static/hw-hacker-annotated.png b/_static/hw-hacker-annotated.png new file mode 100644 index 0000000..9fb5f1c Binary files /dev/null and b/_static/hw-hacker-annotated.png differ diff --git a/_static/hw-hacker-annotated.svg b/_static/hw-hacker-annotated.svg new file mode 100644 index 0000000..6fec307 --- /dev/null +++ b/_static/hw-hacker-annotated.svg @@ -0,0 +1,346 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + FPGA + RGB LED + SPIFlash + Oscillator + + + + VoltageRegulators + + + + + + + + diff --git a/_static/hw-hacker-back-bare-small.jpg b/_static/hw-hacker-back-bare-small.jpg new file mode 100644 index 0000000..d2061a2 Binary files /dev/null and b/_static/hw-hacker-back-bare-small.jpg differ diff --git a/_static/hw-hacker-back-bare.jpg b/_static/hw-hacker-back-bare.jpg new file mode 100644 index 0000000..a0c051c Binary files /dev/null and b/_static/hw-hacker-back-bare.jpg differ diff --git a/_static/hw-hacker-back-case-small.jpg b/_static/hw-hacker-back-case-small.jpg new file mode 100644 index 0000000..ad7cba5 Binary files /dev/null and b/_static/hw-hacker-back-case-small.jpg differ diff --git a/_static/hw-hacker-back-case.jpg b/_static/hw-hacker-back-case.jpg new file mode 100644 index 0000000..e7c95c8 Binary files /dev/null and b/_static/hw-hacker-back-case.jpg differ diff --git a/_static/hw-hacker-front-bare-small.jpg b/_static/hw-hacker-front-bare-small.jpg new file mode 100644 index 0000000..435e5a1 Binary files /dev/null and b/_static/hw-hacker-front-bare-small.jpg differ diff --git a/_static/hw-hacker-front-bare.jpg b/_static/hw-hacker-front-bare.jpg new file mode 100644 index 0000000..2d4a417 Binary files /dev/null and b/_static/hw-hacker-front-bare.jpg differ diff --git a/_static/hw-hacker-front-case-small.jpg b/_static/hw-hacker-front-case-small.jpg new file mode 100644 index 0000000..d65f5f3 Binary files /dev/null and b/_static/hw-hacker-front-case-small.jpg differ diff --git a/_static/hw-hacker-front-case.jpg b/_static/hw-hacker-front-case.jpg new file mode 100644 index 0000000..63ca235 Binary files /dev/null and b/_static/hw-hacker-front-case.jpg differ diff --git a/_static/hw-pvt-annotated.png b/_static/hw-pvt-annotated.png new file mode 100644 index 0000000..5034c69 Binary files /dev/null and b/_static/hw-pvt-annotated.png differ diff --git a/_static/hw-pvt-annotated.svg b/_static/hw-pvt-annotated.svg new file mode 100644 index 0000000..b81dc29 --- /dev/null +++ b/_static/hw-pvt-annotated.svg @@ -0,0 +1,343 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + FPGA + RGB LED + SPIFlash + Oscillator + + + + VoltageRegulators + + + + + + + + diff --git a/_static/hw-pvt-back-bare-small.jpg b/_static/hw-pvt-back-bare-small.jpg new file mode 100644 index 0000000..7baf69f Binary files /dev/null and b/_static/hw-pvt-back-bare-small.jpg differ diff --git a/_static/hw-pvt-back-bare.jpg b/_static/hw-pvt-back-bare.jpg new file mode 100644 index 0000000..e1effa7 Binary files /dev/null and b/_static/hw-pvt-back-bare.jpg differ diff --git a/_static/hw-pvt-front-bare-small.jpg b/_static/hw-pvt-front-bare-small.jpg new file mode 100644 index 0000000..f105507 Binary files /dev/null and b/_static/hw-pvt-front-bare-small.jpg differ diff --git a/_static/hw-pvt-front-bare.jpg b/_static/hw-pvt-front-bare.jpg new file mode 100644 index 0000000..37086b1 Binary files /dev/null and b/_static/hw-pvt-front-bare.jpg differ diff --git a/_static/ice40-arch.png b/_static/ice40-arch.png new file mode 100644 index 0000000..f3d800f Binary files /dev/null and b/_static/ice40-arch.png differ diff --git a/_static/ice40-ledd.png b/_static/ice40-ledd.png new file mode 100644 index 0000000..dec6269 Binary files /dev/null and b/_static/ice40-ledd.png differ diff --git a/_static/ice40-lut.png b/_static/ice40-lut.png new file mode 100644 index 0000000..84cfc36 Binary files /dev/null and b/_static/ice40-lut.png differ diff --git a/_static/ice40-plb.png b/_static/ice40-plb.png new file mode 100644 index 0000000..6b390eb Binary files /dev/null and b/_static/ice40-plb.png differ diff --git a/_static/ice40-rgb.png b/_static/ice40-rgb.png new file mode 100644 index 0000000..9900d42 Binary files /dev/null and b/_static/ice40-rgb.png differ diff --git a/_static/icestudio/blinky.gif b/_static/icestudio/blinky.gif new file mode 100644 index 0000000..4e7a525 Binary files /dev/null and b/_static/icestudio/blinky.gif differ diff --git a/_static/icestudio/blinky_board_options.gif b/_static/icestudio/blinky_board_options.gif new file mode 100644 index 0000000..22b7ae3 Binary files /dev/null and b/_static/icestudio/blinky_board_options.gif differ diff --git a/_static/icestudio/blinky_board_rules.png b/_static/icestudio/blinky_board_rules.png new file mode 100644 index 0000000..5d4b72f Binary files /dev/null and b/_static/icestudio/blinky_board_rules.png differ diff --git a/_static/icestudio/blinky_boardtop.png b/_static/icestudio/blinky_boardtop.png new file mode 100644 index 0000000..1b19be5 Binary files /dev/null and b/_static/icestudio/blinky_boardtop.png differ diff --git a/_static/icestudio/blinky_diagram.png b/_static/icestudio/blinky_diagram.png new file mode 100644 index 0000000..a0809ae Binary files /dev/null and b/_static/icestudio/blinky_diagram.png differ diff --git a/_static/icestudio/blinky_module_rules.png b/_static/icestudio/blinky_module_rules.png new file mode 100644 index 0000000..db9f63d Binary files /dev/null and b/_static/icestudio/blinky_module_rules.png differ diff --git a/_static/icestudio/blinky_steps.png b/_static/icestudio/blinky_steps.png new file mode 100644 index 0000000..5aa0271 Binary files /dev/null and b/_static/icestudio/blinky_steps.png differ diff --git a/_static/icestudio/blinky_video.gif b/_static/icestudio/blinky_video.gif new file mode 100644 index 0000000..4616152 Binary files /dev/null and b/_static/icestudio/blinky_video.gif differ diff --git a/_static/icestudio/clk_buffering.png b/_static/icestudio/clk_buffering.png new file mode 100644 index 0000000..5fa115d Binary files /dev/null and b/_static/icestudio/clk_buffering.png differ diff --git a/_static/icestudio/pwm_generator.png b/_static/icestudio/pwm_generator.png new file mode 100644 index 0000000..122b2b7 Binary files /dev/null and b/_static/icestudio/pwm_generator.png differ diff --git a/_static/icestudio/sb_rgba_drv.png b/_static/icestudio/sb_rgba_drv.png new file mode 100644 index 0000000..851ad26 Binary files /dev/null and b/_static/icestudio/sb_rgba_drv.png differ diff --git a/_static/icon.png b/_static/icon.png new file mode 100644 index 0000000..d3d3202 Binary files /dev/null and b/_static/icon.png differ diff --git a/_static/jquery-3.6.0.js b/_static/jquery-3.6.0.js new file mode 100644 index 0000000..fc6c299 --- /dev/null +++ b/_static/jquery-3.6.0.js @@ -0,0 +1,10881 @@ +/*! + * jQuery JavaScript Library v3.6.0 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright OpenJS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2021-03-02T17:08Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.6.0", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), + function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); + } ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem && elem.namespaceURI, + docElem = elem && ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +} +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the primary Deferred + primary = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + which: true +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + // Suppress native focus or blur as it's already being fired + // in leverageNative. + _default: function() { + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || Object.create( null ) )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml, parserErrorElem; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + data + ) ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ).filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ).map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + +originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Background

+
+

About FPGAs

+

Field Programmable Gate Arrays (FPGAs) +are integrated circuits containing arrays of gates which are programmable +in the field. Most chips you will encounter, have transistor gates arranged +in a fixed order, thus providing a fixed functionality. Conversely, FPGAs +can change their internal connections by simply loading new configurations. +Fundamentally, configurations program lookup tables (LUTs), which form the basic +building blocks of logic. These lookup tables are so important to the design and usage of an +FPGA that they usually form part of the name of the part. For example, +Fomu uses a UP5K, +which has about 5000 LUTs. NeTV used an LX9, +which had about 9000 LUTs, and NeTV2 uses a XC7A35T +that has about 35000 LUTs.

+

FPGA LUTs are almost always n-inputs to 1-output. The ICE family of +FPGAs from Lattice have 4-input LUTs. Xilinx parts tend to have 5-input or +6-input LUTs which generally means they can do more logic in fewer LUTs. +Comparing LUT count between FPGAs is a bit like comparing clock speed +between different CPUs; not entirely accurate, but certainly a helpful +rule of thumb.

+
+The ICE40 LUT4 is a basic 4-input 1-output LUT +
+

The ICE40 LUT4 is a basic 4-input 1-output function table.

+
+
+

The basic building block of Fomu is the SB_LUT4. It +has four 1-bit inputs and one 1-bit output. To program Fomu, we must define what +each possible input 4-bit pattern will create on the output. To do this, we turn to +a truth table:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

0

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

IO0

0

0

0

0

0

0

0

0

1

1

1

1

1

1

1

1

IO1

0

0

0

0

1

1

1

1

0

0

0

0

1

1

1

1

IO2

0

0

1

1

0

0

1

1

0

0

1

1

0

0

1

1

IO3

0

1

0

1

0

1

0

1

0

1

0

1

0

1

0

1

O

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

+

For example, to create a LUT that acted as an AND gate, we would define +O to be 0 for everything except the last column. Conversely, to create +a NAND gate, we would define O to be 1 for everything except the last column. +It is from this simple primitive that we create the building logic blocks of +FPGA design.

+
+PLB Block Diagram (from iCE40 UltraPlus Family Data Sheet) +
+

Programmable Logic Block (PLB), Block Diagram.

+
+
+

Modern FPGA devices are no longer composed of arrays of gates (i.e. LUTs) only. +Typically, LUTs are grouped with flip-flop registers (DFF) and some carry logic, in +so-called Programmable Logic Blocks (PLBs) or Configurable Logic Blocks (CLBs); +depending on the vendor. These resources allow combining multiple LUTs for +describing larger logical functions and for providing sequential behaviour.

+

Furthermore, additional purpose-specific blocks are included in the devices: +Block RAMs (BRAMs), Digital Signal Processing (DSP) blocks, high-performance serial +transmitters/receivers, etc. Those so-called hard blocks allow better +area and power usage than LUT-based components. Nevertheless, the behaviour +of any of those hard blocks can be replicated using PLBs only. At the same time, +custom behaviour can only be described through LUTs, because all hard blocks +are programmable within the pre-fixed functionality only.

+
+

Turning code into gates

+

Configuring all the LUTs, carry logic and other hard blocks manually is +hard and very challenging; so people have come up with abstract +Hardware Description Languages (HDLs), +that allow us to describe the expected behaviour and/or structure. The +two most common languages are Verilog and VHDL. However, a modern trend +is to achieve hardware description by embedding a Domain Specific Language (DSL) +inside an existing programming language, such as how Migen is embedded in Python, +Clash is embedded in Haskell, or Chisel and SpinalHDL are embedded in Scala.

+

Here is an example of a counter module with a registered output:

+
+
module example (
+  input C,
+  output reg [0:5] Q
+);
+  reg [0:8] counter;
+
+  always @(posedge C)
+  begin
+    counter <= counter + 1'b1;
+  end
+
+  always @(posedge C)
+  begin
+    Q <= counter[3] ^ counter[5] | counter<<2;
+  end
+endmodule
+
+
+
+

We can run this HDL module through a synthesizer to turn it into +LUT and DFF blocks, or we can turn it into a more familiar logic +diagram:

+
+A synthesis of the above logic into some gates +
+

A synthesis of the above logic into basic blocks.

+
+
+
+
+

Turning gates into a bitstream

+

If we do decide to synthesize to PLBs, we will end up with +a pile of LUTs and DFFs that need to be strung together somehow. This is done by +a Place-and-Route (PnR) tool. This performs the job of assigning physical PLBs +to each LUT and DFF that gets defined by the synthesizer; and then figuring out +how to wire it all up.

+

Once the PnR tool is done, it generates an abstract file that needs to be +translated into a format that the hardware can recognize. This is done by a +bitstream packing tool.

+
+
+

Loading a bitstream into a device

+

Finally, the bitstream needs to be loaded onto the device somehow. It can be +done manually by toggling wires of the FPGAs programming interface. However, +most FPGAs are volatile, which means the configuration is lost when +unplugged. Therefore, most FPGA boards include some flash memory, which is +typically programmed through SPI. Then, when the FPGA is plugged again, it loads +the configuration from a predefined location in the flash.

+
+
+
+

About the ICE40UP5K

+

We will use an ICE40UP5K for this workshop. This chip has a number of +very nice features:

+
    +

  1. 5280 4-input LUTs (LC)

    2. +

  2. 16 kilobytes BRAM

    3. +

  3. 128 kilobytes “SPRAM”

    4. +

  4. 1x Current-limited 3-channel LED driver

    5. +

  5. 2x I2C and 2x SPI interfaces

    6. +

  6. 8x 16-bit DSP units

    7. +

  7. Warmboot capability

    8. +

  8. Open toolchain

    9. +
+
+iCE40UP5K Device, Top View (from iCE40 UltraPlus Family Data Sheet) +
+

iCE40UP5K Device, Top View.

+
+
+

BRAM is frequently used to store data such as buffers, CPU register files, +and large arrays of data. This type of memory is frequently reused as RAM on +many FPGAs. The ICE40UP5K is unusual in that it also has 128 kilobytes of +Single Ported RAM that can be used as memory for a softcore (a term used for +a CPU core running inside an FPGA, to differentiate it from a ‘hard’ - +i.e. fixed chip - implementation). That means that, unlike other FPGAs, +valuable block RAM isn’t taken up by system memory.

+

Additionally, the ICE40 family of devices generally supports warmboot +capability. This enables us to have multiple designs live on the same +FPGA and tell the FPGA to swap between them.

+

As always, this workshop wouldn’t be nearly as easy without the open +source tools that enable us to port it to a lot of different platforms.

+
+
+

About Fomu

+

Fomu is an ICE40UP5K that fits in your USB port. It contains two +megabytes of SPI flash memory, four edge buttons, and a three-color LED.

+

Unlike most other ICE40 projects, Fomu implements its USB in a softcore. +That means that the bitstream that runs on the FPGA must also provide +the ability to communicate over USB. This uses up a lot of storage on +this small FPGA, but it also enables us to have such a tiny form factor, +and lets us do some really cool things with it.

+
+Block diagram of Fomu +
+

Block diagram of Fomu.

+
+
+

The ICE40UP5K at the heart of Fomu really controls everything, and this +workshop is all about trying to unlock the power of this chip.

+
+

Note

+

Some figures in this section were extracted from the iCE40 UltraPlus Family Data Sheet.

+
+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Required Drivers
+
+ + + arrow_forward +
+ Next +
Python on Fomu
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/bootloader.html b/bootloader.html new file mode 100644 index 0000000..580d40b --- /dev/null +++ b/bootloader.html @@ -0,0 +1,354 @@ + + + + + + + + + + + + Bootloader — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Bootloader

+
+

Updating the Fomu Bootloader

+

To update your Fomu, download the appropriate -updater dfu release from +foboot.

+
    +

  1. Download the board type-updater-v2.0.3.dfu file.

    + +
    2. +

  2. Run dfu-util -D pvt-updater-version.dfu.

    3. +

  3. Your Fomu will flash rainbow for about five seconds, then reboot and go back +to blinking.

    4. +

  4. To verify it has updated, dfu-util -l and check the version output.

    5. +
+

This is an example session for updating a production board:

+
dfu-util -l
+wget https://github.com/im-tomu/foboot/releases/download/v2.0.3/pvt-updater-v2.0.3.dfu -O ~/Downloads/pvt-updater-v2.0.3.dfu
+dfu-util -D ~/Downloads/pvt-updater-v2.0.3.dfu
+sleep 5
+dfu-util -l
+
+
+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Renode Co-simulation using Verilator
+
+ + + arrow_forward +
+ Next +
Getting Help
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 0000000..0ffde28 --- /dev/null +++ b/genindex.html @@ -0,0 +1,241 @@ + + + + + + + + + + + Index — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ + +

Index

+ +
+ +
+ + +
+
+
+
+
+ +
+
+
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/hdl.html b/hdl.html new file mode 100644 index 0000000..96c391b --- /dev/null +++ b/hdl.html @@ -0,0 +1,365 @@ + + + + + + + + + + + + Hardware Description Languages — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Hardware Description Languages

+

The two most common Hardware Description Languages are Verilog and VHDL. +As explained in Turning code into gates, a synthesis tool is used for converting +the human readable HDL into a netlist representation. The synthesis tool used in the Fomu +toolchain is called yosys. Once we have the netlist representation, a tool called +nextpnr performs an operation called place and route (PnR), which makes it something +that will actually run on the FPGA. This is all done for you using the Makefiles in the +subdirectories of any of the following examples: verilog, +vhdl, mixed-hdl, or migen.

+
+

Note

+

nextpnr is timing-driven. This means that a design will be generated with a given +clock domain guaranteed to perform fast enough, but sometimes it won’t optimise further. +When the make command runs nextpnr-ice40 you will see something similar to the +following:

+
Info: Max frequency for clock 'clk': 73.26 MHz (PASS at 12.00 MHz)
+
+
+

This output example shows that we could run clk at up to 73.26 +MHz and it would still be stable (even though we only requested 12.00 +MHz). Note that there is some variation between designs depending on +how the placer and router decided to lay things out, so your exact +frequency numbers might be different from the ones shown in the code +blocks of this documentation.

+
+
+

Important

+

As explained in About Fomu, Fomu implements its USB in a softcore, and +the bitstream that runs on the FPGA must provide the ability to communicate over USB. +That is a tradeoff for achieving such a tiny board size, which unfortunately makes +it not straightforward to use non-trivial HDL designs. This is because +I/O is very limited, hence, it is challenging to actually see whether the designs are +behaving as expected. Ideally, a USB-to-UART core would be provided for users to instantiate +in their HDL designs. Should you be interested in helping achieve it, let us know! +Meanwhile, Migen and LiteX examples provide a working SoC that allows interacting +through USB using a Wishbone Bus.

+
+
+iCE40 UltraLite and iCE40 UltraPlus RGB Port Level Diagram +
+

iCE40 UltraLite and iCE40 UltraPlus RGB Port Level Diagram.

+
+
+

Regardless of the HDL language or higher abstraction programming language used for +describing the design, all the examples in this workshop do use the hard RGB block +for driving the LED on the board. It is defined as a Verilog module or VHDL component +named SB_RGBA_DRV. +As shown in the block diagram from the datasheet, the RGB driver has five inputs +(CURREN, RGBLEDEN, RGB0PWM, RGB1PWM, and RGB2PWM), +and three outputs (RGB0, RGB1, and RGB2). It also has four parameters: +CURRENT_MODE, RGB0_CURRENT, RGB1_CURRENT, and RGB2_CURRENT. As a result, +it allows driving the LEDs safely, by specifying the current limit for each of them. +More information on this driver can be found in the ICE40 LED Driver Usage Guide.

+
+

Attention

+

Even though it is possible to drive the RGB outputs directly (i.e. without instantiating +SB_RGBA_DRV), it is strongly discouraged, as it might damage the LEDs.

+
+
+

Languages and generators

+
+ +
+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Fomu as a CPU
+
+ + + arrow_forward +
+ Next +
Verilog on Fomu
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/help.html b/help.html new file mode 100644 index 0000000..a82825a --- /dev/null +++ b/help.html @@ -0,0 +1,288 @@ + + + + + + + + + + + + Getting Help — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Getting Help

+

If you get stuck anywhere in the workshop you can use the following channels to +get help!

+
+

IRC Chat Channel

+

IRC (Internet Relay Chat) +is old school chat before Slack became popular. You can connect with a wide +range of different clients including web based clients like +IRCCloud.

+ +
+
+

Mailing Lists

+ +
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Bootloader
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/icestudio.html b/icestudio.html new file mode 100644 index 0000000..6520237 --- /dev/null +++ b/icestudio.html @@ -0,0 +1,357 @@ + + + + + + + + + + + + Fomu on IceStudio Nightly — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Fomu on IceStudio Nightly

+
+

Important

+

Fomu is currently not supported in the stable releases +of IceStudio. Development or nightly +releases need to be used.

+
+ +
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Migen and LiteX
+
+ + + arrow_forward +
+ Next +
Working with LiteX and (co-)simulation with Renode
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..275d30d --- /dev/null +++ b/index.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + FPGA Tomu Workshop — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

FPGA Tomu Workshop

+Fomu logo +

Hi, I’m Fomu (FPGA Tomu)! +This workshop covers the basics of Fomu in a top-down approach. We’ll +start out by learning what Fomu is, how to load software into Fomu, +how to write software for Fomu, and finally how to write hardware for Fomu.

+

FPGAs are complex, weird things, so we’ll take a gentle approach and +start out by treating it like a Python interpreter first, and gradually +peel away layers until we’re writing our own hardware registers. You can +take a break at any time and explore! Stop when you feel the concepts +are too unfamiliar, or plough on and dig deep into the world of +hardware.

+
+
+
+ + +
+
+
+
+
+ +
+
+ + arrow_forward +
+ Next +
Requirements
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/migen.html b/migen.html new file mode 100644 index 0000000..beb1e8b --- /dev/null +++ b/migen.html @@ -0,0 +1,445 @@ + + + + + + + + + + + + Migen and LiteX — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Migen and LiteX

+ +
+

Wishbone Bus Basics

+

LiteX provides us with a Wishbone abstraction layer. There really is no +reason we need to include a CPU with our design, but we can still reuse +the USB Wishbone bridge in order to write HDL code.

+

We can use DummyUsb to respond to USB requests and bridge USB to +Wishbone, and rely on LiteX to generate registers and wire them to +hardware signals. We can still use wishbone-tool to read and write +memory, and with a wishbone bridge we can actually have code running on +our local system that can read and write memory on Fomu.

+

Go to the litex directory and build the design;

+
python3 workshop.py --board $FOMU_REV
+
+
+

Load it onto Fomu:

+
dfu-util -D build/gateware/fomu_$FOMU_REV.bin
+
+
+

If you get an error message about missing modules, check you have all +submodules cloned and setup with;

+
git submodule update --recursive --init
+
+
+

Take a look at build/csr.csv. This describes the various regions +present in our design. You can see +memory_region,sram,0x10000000,131072, which indicates the RAM is 128 +kilobytes long and is located at 0x10000000, just as when we had a +CPU. You can also see the timer, which is a feature that comes as part +of LiteX. Let’s try reading and writing RAM:

+
wishbone-tool 0x10000000
+wishbone-tool 0x10000000 0x98765432
+wishbone-tool 0x10000000
+
+
+
+
+

Wishbone Bus Extension

+

Aside from that, there’s not much we can do with this design. But +there’s a lot of infrastructure there. So let’s add something we can see +(workshop_rgb.py contains the completed example).

+

As explained in Hardware Description Languages the RGB LED driver is defined in Verilog/VHDL +(as SB_RGBA_DRV), but we can import it as a Module into Migen:

+
class FomuRGB(Module, AutoCSR):
+    def __init__(self, pads):
+        self.output = CSRStorage(3)
+        self.specials += Instance("SB_RGBA_DRV",
+            i_CURREN = 0b1,
+            i_RGBLEDEN = 0b1,
+            i_RGB0PWM = self.output.storage[0],
+            i_RGB1PWM = self.output.storage[1],
+            i_RGB2PWM = self.output.storage[2],
+            o_RGB0 = pads.r,
+            o_RGB1 = pads.g,
+            o_RGB2 = pads.b,
+            p_CURRENT_MODE = "0b1",
+            p_RGB0_CURRENT = "0b000011",
+            p_RGB1_CURRENT = "0b000011",
+            p_RGB2_CURRENT = "0b000011",
+        )
+
+
+

This will instantiate this Verilog block and connect it up. It also +creates a CSRStorage object that is three bits wide, and assigns it +to output. By having this derive from AutoCSR, the CSRStorage +will have CSR bus accessor methods added to it automatically. Finally, +it wires the pads up to the outputs of the block.

+

We can instantiate this block by simply creating a new object and adding +it to self.specials in our design:

+
...
+    # Add the LED driver block
+    led_pads = soc.platform.request("rgb_led")
+    soc.submodules.fomu_rgb = FomuRGB(led_pads)
+
+
+

Finally, we need to add it to the csr_map:

+
...
+    soc.add_csr("fomu_rgb")
+
+
+

Now, when we rebuild this design and check build/csr.csv we can see +our new register:

+
csr_register,fomu_rgb_output,0x60003000,1,rw
+
+
+

We can use wishbone-tool to write values to 0x60003000 (or whatever +your build/csr.csv says) and see them take effect immediately.

+
wishbone-tool 0x60003000 0x1 # make LED green
+wishbone-tool 0x60003000 0x2 # make LED red
+wishbone-tool 0x60003000 0x3 # make LED yellow
+wishbone-tool 0x60003000 0x4 # make LED blue
+wishbone-tool 0x60003000 0x5 # make LED teal
+wishbone-tool 0x60003000 0x6 # make LED pink
+wishbone-tool 0x60003000 0x7 # make LED white
+
+
+

You can see that it takes very little code to take a Signal from HDL and +expose it on the Wishbone bus.

+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Mixed HDL on Fomu
+
+ + + arrow_forward +
+ Next +
Fomu on IceStudio Nightly
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/mixed-hdl.html b/mixed-hdl.html new file mode 100644 index 0000000..0b76d6a --- /dev/null +++ b/mixed-hdl.html @@ -0,0 +1,347 @@ + + + + + + + + + + + + Mixed HDL on Fomu — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Mixed HDL on Fomu

+
+

Hint

+

It is strongly suggested to get familiar with Verilog on Fomu and VHDL on Fomu examples before +tinkering with these mixed language use cases.

+
+ +
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
VHDL on Fomu
+
+ + + arrow_forward +
+ Next +
Migen and LiteX
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 0000000..f175f5e Binary files /dev/null and b/objects.inv differ diff --git a/python.html b/python.html new file mode 100644 index 0000000..a047184 --- /dev/null +++ b/python.html @@ -0,0 +1,444 @@ + + + + + + + + + + + + Python on Fomu — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Python on Fomu

+

You can load MicroPython, a small Python +implementation, onto Fomu as an ordinary RISC-V binary. A precompiled +binary is located in the root of the Fomu workshop files.

+

Use dfu-util to load it:

+
dfu-util -D micropython-fomu.dfu
+
+
+
+

If you’re on a macOS machine, use the following command to connect to +the device:

+
screen /dev/cu.usb*
+
+
+
+

You should be greeted with a MicroPython banner and REPL:

+
+
+

This is a fully-functioning MicroPython shell. Try running some simple +commands such as print() and hex(9876+1234).

+
+

Fomu Python Extensions

+

Fomu’s MicroPython binary contains a few extended Python modules that +you can use to interact with some of the hardware. For example, the RGB +LED has some predefined modes you can access. These are all located +under the fomu module.

+

Import the fomu module and access the rgb block to change the +mode to the predefined error mode:

+
import fomu
+rgb = fomu.rgb()
+rgb.mode("error")
+
+
+

We can also look at some information from the SPI flash, such as the SPI +ID. This ID varies between Fomu models, so it can be a good indication +of what kind of Fomu your code is running on:

+
spi = fomu.spi()
+hex(spi.id())
+
+
+
+
+

Memory-mapped Registers

+

If we look at the generated Fomu header files (to be found for instance in +riscv-blink), we can see +many, many memory-mapped registers. For example, the major, minor, and revision +numbers all have registers:

+
#define CSR_VERSION_MAJOR_ADDR 0xe0007000
+#define CSR_VERSION_MINOR_ADDR 0xe0007004
+#define CSR_VERSION_REVISION_ADDR 0xe0007008
+#define CSR_VERSION_MODEL_ADDR 0xe0007028
+
+
+

These are special areas of memory that don’t really exist. Instead, they +correspond to hardware. We can read these values using the machine +class. Read out the major, minor, and revision codes from your Fomu. +They may be different from what you see here:

+
import machine
+machine.mem32[0xe0007000]
+machine.mem32[0xe0007004]
+machine.mem32[0xe0007008]
+
+
+

The CSR_VERSION_MODEL_ADDR contains a single character that +indicates what version of the hardware you have. We can convert this to +a character and print it out.

+

If you have a production board you will get P as shown below;

+
chr(machine.mem32[0xe0007028])
+
+
+

If you have a hacker board you will get H as shown below;

+
chr(machine.mem32[0xe0007028])
+
+
+
+

Memory-mapped RGB driver

+

The blinking LED is actually a hardware block from Lattice. It has +control registers, and we can modify these registers by writing to +memory in Fomu. Some of these registers control things such as the +timing of the fade in and fade out pulses, and some control the level of +each of the three colors.

+Registers of the ICE40 RGB driver +

There is a wrapper in Fomu’s MicroPython that simplifies the process of +writing to these registers. The first argument is the register number, +and the second argument is the value to write.

+

For the LEDDPWR registers, the second argument determines the +brightness, value ranges from 0 to 255.

+

Try changing the color of the three LEDs:

+
ADDR_RED_LED_PULSE_WIDTH   = 0b0001 # LEDDPWRR
+ADDR_GREEN_LED_PULSE_WIDTH = 0b0010 # LEDDPWRG
+ADDR_BLUE_LED_PULSE_WIDTH  = 0b0011 # LEDDPWRB
+rgb.write_raw(ADDR_RED_LED_PULSE_WIDTH, 255)  # Red LED fully on
+rgb.write_raw(ADDR_GREEN_LED_PULSE_WIDTH, 14) # Green LED mostly off
+rgb.write_raw(ADDR_BLUE_LED_PULSE_WIDTH, 1)   # Blue LED off
+
+
+

The color should change immediately. More information on these registers +can be found in the ICE40 LED Driver Usage Guide.

+
+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Background
+
+ + + arrow_forward +
+ Next +
Fomu as a CPU
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/renode-bridge.html b/renode-bridge.html new file mode 100644 index 0000000..a5868c0 --- /dev/null +++ b/renode-bridge.html @@ -0,0 +1,419 @@ + + + + + + + + + + + + Wishbone bridge between Renode and Fomu — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Wishbone bridge between Renode and Fomu

+

This part of the workshop is based on a Renode, Fomu and Etherbone +bridge +example +from the Renode documentation.

+

Just like we can access Fomu peripherals using wishbone-tool, we can +also connect to a physical board from Renode, mapping a part of the +memory space to be accessible via the Etherbone protocol.

+

This is a very useful capability as it enables us to potentially +simulate an advanced LiteX SoC system which would not normally fit in +the FPGA (or e.g. take a long time to synthesize), and interface it with +the remaining part of the physical system for I/O.

+
+

Setting up the server

+

You can use wishbone-tool to bridge protocols such as USB to Etherbone. +To start the server, run the following command:

+
wishbone-tool -s wishbone
+
+
+

This starts an Etherbone server on localhost:1234 by default. See +wishbone-tool --help to change these settings.

+

Now you can start Renode and setup the platform.

+
+
+

Connecting from Renode

+

Run renode and in the Monitor type:

+
(monitor) include @scripts/complex/fomu/renode_etherbone_fomu.resc
+(machine-0) start
+Starting emulation...
+(machine-0) sysbus LogPeripheralAccess sysbus.led
+
+
+

You see a new window with a shell +application, +that provides additional commands allowing you to control LEDs on Fomu.

+
led_toggle
+led_breathe
+
+
+

The led_toggle command controls the LED by turning it on and off. +led_breathe makes the LED fade slowly in and out, creating a +“breathe” effect.

+

The script you loaded configures Renode to log all communication with +Fomu. After issuing some commands in Zephyr’s shell you’ll see:

+
01:00:31.8276 [DEBUG] led: [cpu: 0x40000988] WriteUInt32 to 0x8 (unknown), value 0x7.
+01:00:31.8279 [DEBUG] led: [cpu: 0x40000990] WriteUInt32 to 0x4 (unknown), value 0x8.
+01:00:31.8290 [DEBUG] led: [cpu: 0x40000998] WriteUInt32 to 0x0 (unknown), value 0xC8.
+01:00:31.8298 [DEBUG] led: [cpu: 0x400009A0] WriteUInt32 to 0x4 (unknown), value 0x9.
+01:00:31.8301 [DEBUG] led: [cpu: 0x400009A8] WriteUInt32 to 0x0 (unknown), value 0xBA.
+01:00:31.8305 [DEBUG] led: [cpu: 0x400009B0] WriteUInt32 to 0x8 (unknown), value 0x6.
+01:00:31.8308 [DEBUG] led: [cpu: 0x400009B4] WriteUInt32 to 0x8 (unknown), value 0x7.
+01:00:31.8311 [DEBUG] led: [cpu: 0x400009BC] WriteUInt32 to 0x4 (unknown), value 0x5.
+01:00:31.8314 [DEBUG] led: [cpu: 0x400009C0] WriteUInt32 to 0x0 (unknown), value 0x0.
+01:00:31.8317 [DEBUG] led: [cpu: 0x400009C4] WriteUInt32 to 0x4 (unknown), value 0x6.
+01:00:31.8321 [DEBUG] led: [cpu: 0x400009C8] WriteUInt32 to 0x0 (unknown), value 0x0.
+01:00:31.8324 [DEBUG] led: [cpu: 0x400009D0] WriteUInt32 to 0x4 (unknown), value 0x2.
+01:00:31.8327 [DEBUG] led: [cpu: 0x400009D4] WriteUInt32 to 0x0 (unknown), value 0x0.
+01:00:31.8331 [DEBUG] led: [cpu: 0x400009DC] WriteUInt32 to 0x4 (unknown), value 0x3.
+01:00:31.8334 [DEBUG] led: [cpu: 0x400009E0] WriteUInt32 to 0x0 (unknown), value 0x0.
+01:00:31.8337 [DEBUG] led: [cpu: 0x400009E8] WriteUInt32 to 0x4 (unknown), value 0x1.
+01:00:31.8341 [DEBUG] led: [cpu: 0x400009F4] WriteUInt32 to 0x0 (unknown), value 0xFF.
+01:00:31.8344 [DEBUG] led: [cpu: 0x40000A08] WriteUInt32 to 0x4 (unknown), value 0xA.
+01:00:31.8347 [DEBUG] led: [cpu: 0x40000A0C] WriteUInt32 to 0x0 (unknown), value 0x0.
+01:00:31.8350 [DEBUG] led: [cpu: 0x40000A14] WriteUInt32 to 0x4 (unknown), value 0xB.
+01:00:31.8353 [DEBUG] led: [cpu: 0x40000A18] WriteUInt32 to 0x0 (unknown), value 0xFF.
+
+
+

You can interact with Fomu manually, via the Monitor. To do that, you +first need to find the name of the peripheral that serves the connection +to Fomu.

+

Type in peripherals to see a list of all the elements of the +emulated SoC. Look for EtherBoneBridge entry:

+
(machine-0) peripherals
+Available peripherals:
+  sysbus (SystemBus)
+  │
+  ├── cpu (VexRiscv)
+  │     Slot: 0
+  │
+  ├── ddr (MappedMemory)
+  │     <0x40000000, 0x4FFFFFFF>
+  │     <0xC0000000, 0xCFFFFFFF>
+  │
+  ├── eth (LiteX_Ethernet)
+  │   │ <0x60007800, 0x600078FF>
+  │   │ <0xE0007800, 0xE00078FF>
+  │   │ <0x30000000, 0x30001FFF>
+  │   │ <0xB0000000, 0xB0001FFF>
+  │   │ <0x60007000, 0x600077FF>
+  │   │ <0xE0007000, 0xE00077FF>
+  │   │
+  │   └── phy (EthernetPhysicalLayer)
+  │         Address: 0
+  │
+  ├── flash_mem (MappedMemory)
+  │     <0x20000000, 0x21FFFFFF>
+  │     <0xA0000000, 0xA1FFFFFF>
+  │
+  ├── led (EtherBoneBridge)
+  │     <0xE0006800, 0xE00068FF>
+  │
+  ├── mem (MappedMemory)
+  │     <0x00000000, 0x0003FFFF>
+  │     <0x80000000, 0x8003FFFF>
+  │
+  ├── spi (LiteX_SPI_Flash)
+  │   │ <0x60005000, 0x6000500F>
+  │   │ <0xE0005000, 0xE000500F>
+  │   │
+  │   └── flash (Micron_MT25Q)
+  │
+  ├── sram (MappedMemory)
+  │     <0x10000000, 0x1003FFFF>
+  │     <0x90000000, 0x9003FFFF>
+  │
+  ├── timer0 (LiteX_Timer)
+  │     <0x60002800, 0x60002843>
+  │     <0xE0002800, 0xE0002843>
+  │
+  └── uart (LiteX_UART)
+        <0x60001800, 0x600018FF>
+        <0xE0001800, 0xE00018FF>
+
+
+

The device that acts as a connector to Fomu is called led and is +registered at 0xE0006800:

+
├── led (EtherBoneBridge)
+│     <0xE0006800, 0xE00068FF>
+
+
+

You can either use a full or relative address (via the sysbus or +led objects, respectively) to communicate with the physical LED +controller:

+
(machine-0) sysbus WriteDoubleWord 0xE0006804 0x1234 # writes 0x1234 to the given address
+(machine-0) led WriteDoubleWord 0x4 0x4321 # writes 0x4321 to 0xE0006800 + 0x4
+
+
+

Note: the above values are just an example and won’t change the LED +status in any visible way. If you want to enable “breathe” effect +directly from the Monitor, see the necessary sequence in the +application source +code.

+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Running your own Zephyr binary on LiteX/VexRiscv in Renode
+
+ + + arrow_forward +
+ Next +
Renode Co-simulation using Verilator
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/renode-starting.html b/renode-starting.html new file mode 100644 index 0000000..0096622 --- /dev/null +++ b/renode-starting.html @@ -0,0 +1,311 @@ + + + + + + + + + + + + Getting Renode — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Getting Renode

+

Renode is available for Linux, macOS and Windows.

+

On Linux and macOS, you need to have +Mono installed on your computer. You +should follow the Mono installation +instructions and +install the mono-complete package.

+

On Windows it’s enough to have a fairly recent .NET +Framework +installed.

+

Then you can either install Renode from prebuilt +packages, or compile +it +yourself.

+
+

Try out Renode quickly with precompiled LiteX demos

+

Renode comes with several precompiled demos, which can be used to verify +everything works for you before starting to compile and use your own +software binaries.

+

There are three demo scripts available:

+
    +

  • litex_vexriscv_micropython.resc

    • +

  • litex_vexriscv_zephyr.resc

    • +

  • litex_vexriscv_linux.resc

    • +
+

To run them, start Renode using the renode command (or ./renode +if you built from sources).

+

You will see a terminal window pop up, which is the Renode CLI, called +the Monitor.

+

In the Monitor type:

+
(monitor) start @scripts/single-node/<script_name>
+
+
+

(where is one of the above).

+

Voila! A UART analyzer window should appear and you should see LiteX +booting the respective binary.

+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Working with LiteX and (co-)simulation with Renode
+
+ + + arrow_forward +
+ Next +
Running your own Zephyr binary on LiteX/VexRiscv in Renode
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/renode-verilator.html b/renode-verilator.html new file mode 100644 index 0000000..2af8b15 --- /dev/null +++ b/renode-verilator.html @@ -0,0 +1,373 @@ + + + + + + + + + + + + Renode Co-simulation using Verilator — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Renode Co-simulation using Verilator

+

While connecting Renode to a real FPGA gives you some interesting +possibilities in testing and debugging your gateware together with your +software, there is another usage scenario which is completely hardware +independent - connecting functional simulation of the base system in +Renode with HDL simulation of a part of the system that is under +development.

+

To this end, Renode provides an integration layer for Verilator. A +typical setup with Renode + Verilator consists of several components:

+
    +

  • the ‘verilated’ HDL code itself (e.g. a UART peripheral),

    • +

  • Verilator integration library, provided as a plugin to +Renode,

    • +

  • shim layer in C++ connecting the above.

    • +
+

Currently Renode supports peripherals with the AXILite interface. Keep +in mind that due to the abstract nature of bus operations in Renode, it +doesn’t matter what kind of bus is used on the hardware you want to +simulate.

+

In the Renode tree you will find an example with all the elements +already prepared. To run it, start Renode and type:

+
(monitor) include @scripts/single-node/riscv_verilated_uartlite.resc
+(UARTLite) start
+
+
+

This script loads a RISC-V-based system with a verilated UARTLite. You +can verify it by calling:

+
(UARTLite) sysbus WhatPeripheralIsAt 0x70000000
+Antmicro.Renode.Peripherals.Verilated.VerilatedUART
+
+
+

To inspect the communication with the UART, run:

+
(UARTLite) sysbus LogPeripheralAccess uart
+
+
+

You will see every read and write to the peripheral displayed in the +Renode log.

+

Please note that, despite not being a Renode-native model, the UART is +also capable of displaying an analyzer window. This is because Renode +adds a special support for UART-type peripherals, allowing you not only +to connect bus lines, but also the TX and RX UART lines, to the Renode +infrastructure.

+

The HDL and integration layer for this UART peripheral is available on +Antmicro’s +GitHub.

+

To compile it manually, you need to have ZeroMQ (libzmq3-dev on +Debian-like systems) and Verilator installed in your system. You +also need to provide a full path to the +src/Plugins/VerilatorPlugin/VerilatorIntegrationLibrary directory as +the INTEGRATION_DIR environment variable. This means that you need +to have a copy of Renode sources to build a verilated peripheral.

+

With this set up, simply run make.

+
+

Integration with verilated code

+

Renode supports integration with Verilator via AXILite bus, but can be +easily expanded to support other standards as well.

+

We’ll briefly take a look on the integration layer implemented in +sim-main.cpp.

+

First, the user has to decide on the bus type and peripheral type. These +are provided by the integration library:

+
#include "src/peripherals/uart.h"
+#include "src/buses/axilite.h"
+
+
+

A bus is a type declaring all the signals and how should they be handled +on each transaction. These signals have to be connected to the signals +in the HDL design:

+
void Init() {
+    AxiLite* bus = new AxiLite();
+
+    //=================================================
+    // Init bus signals
+    //=================================================
+    bus->clk = &top->clk;
+    bus->rst = &top->rst;
+    bus->awaddr = (unsigned long *)&top->awaddr;
+    bus->awvalid = &top->awvalid;
+    bus->awready = &top->awready;
+    bus->wdata = (unsigned long *)&top->wdata;
+    bus->wstrb = &top->wstrb;
+    bus->wvalid = &top->wvalid;
+    bus->wready = &top->wready;
+    bus->bresp = &top->bresp;
+    bus->bvalid = &top->bvalid;
+    bus->bready = &top->bready;
+    [...]
+
+
+

To handle the “external” communication, the user can either use the base +RenodeAgent class of one of its derivatives: for example the +UART type allows you to connect RX and TX signals:

+
// Init peripheral
+//=================================================
+uart = new UART(bus, &top->txd, &top->rxd, prescaler);
+
+
+

For more details, see the verilated uartlite +repository.

+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Wishbone bridge between Renode and Fomu
+
+ + + arrow_forward +
+ Next +
Bootloader
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/renode-zephyr.html b/renode-zephyr.html new file mode 100644 index 0000000..b434300 --- /dev/null +++ b/renode-zephyr.html @@ -0,0 +1,340 @@ + + + + + + + + + + + + Running your own Zephyr binary on LiteX/VexRiscv in Renode — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Running your own Zephyr binary on LiteX/VexRiscv in Renode

+

Zephyr is a very capable RTOS governed by a Linux Foundation subproject. +It is very well supported on the RISC-V architecture, as well as in +LiteX.

+
+

Building a Zephyr application

+

To install all the dependencies and prepare the environment for building +the Zephyr application follow the official Zephyr Getting Started +Guide +up to point 4. On Linux you can follow the instructions from the point 5 +on installing the Software Development Toolchain. The python version +in the FOMU toolchain may not work; remove it from your PATH before +attempting to build zephyr. +For other operating +systems, if you followed the instructions from the Required Software +section of this tutorial, you should have a toolchain in PATH.

+

On macOS and Windows you also need to set some additional variables.

+

For macOS:

+
export ZEPHYR_TOOLCHAIN_VARIANT=cross-compile
+export CROSS_COMPILE=riscv64-unknown-elf-
+
+
+

For Windows:

+
set ZEPHYR_TOOLCHAIN_VARIANT=cross-compile
+set CROSS_COMPILE=riscv64-unknown-elf-
+
+
+

To build the shell demo application for the LiteX/VexRiscv board run +the following commands on Linux and macOS:

+
cd ~/zephyrproject/zephyr
+source zephyr-env.sh
+west build -p auto -b litex_vexriscv samples/subsys/shell/shell_module/
+
+
+

And on Windows:

+
cd %HOMEPATH%\zephyrproject\zephyr
+zephyr-env.cmd
+west build -p auto -b litex_vexriscv samples\subsys\shell\shell_module\
+
+
+

The resulting ELF file will be in build/zephyr/zephyr.elf.

+
+
+

Run the app in Renode

+

To run the app you just compiled, you basically need to replace the +precomipled demo binary with the one you want, by setting the zephyr +variable - see below.

+

Just like before, start Renode using the renode command (or +./renode if you built from sources).

+

You will see the Monitor, where you should type:

+
(monitor) $zephyr=@/path/to/zephyrproject/zephyr/build/zephyr/zephyr.elf
+(monitor) start @scripts/single-node/litex_vexriscv_zephyr.resc
+
+
+

You should see a new window pop up for the serial port. In it, you +should see the Zephyr interactive shell.

+
+
+

Debugging the app in Renode

+

In general, debugging in Renode is done with GDB just like with a +physical board - you connect to a debug port and execute GDB commands as +usual. For details, see the Renode debugging +documentation.

+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Getting Renode
+
+ + + arrow_forward +
+ Next +
Wishbone bridge between Renode and Fomu
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/renode.html b/renode.html new file mode 100644 index 0000000..f5bc056 --- /dev/null +++ b/renode.html @@ -0,0 +1,308 @@ + + + + + + + + + + + + Working with LiteX and (co-)simulation with Renode — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Working with LiteX and (co-)simulation with Renode

+

LiteX used as the soft SoC on Fomu is a very robust and scalable soft +SoC platform, capable of running both bare metal binaries, Zephyr and +even Linux.

+

It is also supported in Renode, which is an open +source simulation framework that lets you run unmodified software in a +fully controlled and inspectable environment. Renode is a functional +simulator, which means it aims to mimic the observable behavior of the +hardware instead of trying to be cycle-accurate.

+

We will now see how a full-blown Zephyr RTOS can be run on LiteX in +Renode, and then how this simulation can be interfaced with a Fomu for a +useful HW/SW co-development workflow.

+
+

Tip

+

Apart from RISC-V and LiteX platforms, Renode supports many +other architectures and platforms, as described in the +documentation, +which also includes a user manual and a few tutorials. You can also +take a look at a Video Tutorials section on Renode’s +website.

+
+

Keep in mind that all platforms and configurations in Renode used in +this tutorial are contained in text/config files - you can also explore +Renode’s usage patterns by just inspecting those files for details.

+
+ +
+
+ + +
+
+
+
+
+ +
+
+ + arrow_back +
+ Previous +
Fomu on IceStudio Nightly
+
+ + + arrow_forward +
+ Next +
Getting Renode
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/requirements/drivers.html b/requirements/drivers.html new file mode 100644 index 0000000..4ead45c --- /dev/null +++ b/requirements/drivers.html @@ -0,0 +1,370 @@ + + + + + + + + + + + + Required Drivers — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Required Drivers

+

On most systems (such as Windows 10 or newer, or MacOS X), the Fomu board does not need any special drivers.

+
    +

  • On GNU/Linux, you do not need to install any drivers, however, you may need +sudo access unless you Setup udev rules to grant permission for using the +USB device from a non-privileged account.

    • +

  • Windows systems earlier than Windows 10: you will need to +install Zadig drivers.

    • +
+
+

Setup udev rules

+
+

Warning

+

This set up is for GNU/Linux only. Setting up these udev rules grants +permissions for using the USB device from a non-privileged account.

+
+

On GNU/Linux, try running dfu-util -l. If you get an error message like the +following, you should add a udev rule as to give your user permission to the +USB device.

+
dfu-util -l
+
+
+
+

Steps to set up udev rule

+
    +

  1. Add your user to group plugdev:

    +
    sudo groupadd plugdev
+sudo usermod -a -G plugdev $USER
+
    +
    +
    +

    Warning

    +

    You must log out and then log in again for the addition to group plugdev to take affect.

    +
    +
    2. +

  2. Use id $USER and/or groups to check you are in group plugdev:

    +
    id $USER
+groups | grep plugdev
+
    +
    +
    3. +

  3. Create a file named /etc/udev/rules.d/99-fomu.rules and add the following.

    +
    SUBSYSTEM=="usb", ATTRS{idVendor}=="1209", ATTRS{idProduct}=="5bf0", MODE="0664", GROUP="plugdev"
+
    +
    +
    +

    Note

    +

    You need sudo privileges for creating this file.

    +
    +
    4. +

  4. Reload the udev-rules using the following:

    +
    sudo udevadm control --reload-rules
+sudo udevadm trigger
+
    +
    +
    5. +
+
+
+
+

Installing Zadig Drivers

+
+

Warning

+

This set up is only needed for Windows system earlier than Windows 10.

+
+
    +

  1. Download Zadig.

    2. +

  2. Open Zadig.

    3. +

  3. Under Options, select List All Devices.

    4. +

  4. In the dropdown, select your Fomu; in the field right of the green arrow, +choose the WinUSB driver; and hit Upgrade Driver.

    +
    +Setup of Zadig for updating USB port driver on Windows earlier than 10 +
    +

    Setup of Zadig for updating USB port driver on Windows earlier than 10.

    +
    +
    +
    5. +
+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Required Hardware
+
+ + + arrow_forward +
+ Next +
Background
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/requirements/files.html b/requirements/files.html new file mode 100644 index 0000000..a8b50a8 --- /dev/null +++ b/requirements/files.html @@ -0,0 +1,304 @@ + + + + + + + + + + + + Required Files — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Required Files

+
+

Note

+

If you’re attending a workshop that provides USB drives, these files may be +available on the USB drive under the Workshop directory.

+
+

You will need the Workshop files. They are located in the +fomu-workshop Github +repository. You can clone it with git, or download +master.zip | +master.tar.gz.

+
git clone --recurse-submodules https://github.com/im-tomu/fomu-workshop.git
+
+
+
+ + +
+
+
+
+
+ +
+
+ + arrow_back +
+ Previous +
Requirements
+
+ + + arrow_forward +
+ Next +
Required Software
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/requirements/hardware.html b/requirements/hardware.html new file mode 100644 index 0000000..5ca025f --- /dev/null +++ b/requirements/hardware.html @@ -0,0 +1,366 @@ + + + + + + + + + + + + Required Hardware — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Required Hardware

+
    +

  • For this workshop, you will need a Fomu board.

    • +

  • Aside from that, you need a computer with a USB port that can run the Required Software.

    • +
+
+

Note

+

You should not need any special drivers, though on Linux you may need sudo +access, or special udev rules for granting permission to use the USB device from a +non-privileged account.

+
+
+

Attention

+

This workshop may be competed with any model of Fomu, though there are some +parts that require you to identify which model you have. See the +Which Fomu do I have? below.

+
+
+

Which Fomu do I have?

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Hacker

Production

String

hacker

pvt

Bash Command

export FOMU_REV=hacker

export FOMU_REV=pvt

Front

Hacker Hardware Front without case

Production Hardware Front without case

Back

Hacker Hardware Back without case

Production Hardware Back without case

In Case

Hacker Hardware Back with case

Production Hardware Back with case

Parts

Hacker Hardware Annotated Diagram

Production Hardware Annotated Diagram

Color

dark blue

cyan / light blue

Bootloader

Fomu Hacker running DFU Bootloader vX.X.X

Fomu PVT running DFU Bootloader vX.X.X

Description

These are the original design and cut corners to make it easier to +manufacture. If you received one directly from Tim before 36C3, you +probably have one of these. Hacker boards have white silkscreen on +the back.

If you ordered a Fomu from Crowd Supply, this is the model you’ll +receive. It is small, and fits in a USB port. There is no +silkscreen on it. This model of Fomu has a large silver crystal +oscillator that is the tallest component on the board.

Schematic

schematic-hacker.pdf

schematic-pvt.pdf

Received at

From Tim at 35C3, CCCamp19, HackADay Supercon 2019

At RISC-V Summit 2019, 36C3, Crowdsupply, Mouser

Buy more

End of Life

CrowdSupply,

+
+

Note

+

There are also Fomu EVT boards which were shipped to early backers of +the Fomu crowd funding campaign. This model of Fomu is about the size +of a credit card. It should have the text “Fomu EVT3” written across +it in white silkscreen. If you have a different EVT board such as +EVT2 or EVT1, they should also work.

+
+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Required Software
+
+ + + arrow_forward +
+ Next +
Required Drivers
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/requirements/index.html b/requirements/index.html new file mode 100644 index 0000000..41a9cf8 --- /dev/null +++ b/requirements/index.html @@ -0,0 +1,315 @@ + + + + + + + + + + + + Requirements — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Requirements

+
+

Note

+

If you are at a workshop, please install the tools first and then get +the hardware from your presenter.

+
+

For this workshop you will need:

+ +
+

Warning

+

Your Fomu should be running Foboot v2.0.3 or newer.

+

You can see what version you are running by typing dfu-util -l like so;

+
dfu-util -l
+
+
+

If your Fomu is running an version older than v2.0.3, follow the +Updating the Fomu Bootloader section.

+
+
+ +
+
+ + +
+
+
+
+
+ +
+
+ + arrow_back +
+ Previous +
FPGA Tomu Workshop
+
+ + + arrow_forward +
+ Next +
Required Files
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/requirements/software.html b/requirements/software.html new file mode 100644 index 0000000..8417fe6 --- /dev/null +++ b/requirements/software.html @@ -0,0 +1,394 @@ + + + + + + + + + + + + Required Software — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Required Software

+

Fomu requires specialized software.

+
+

Note

+

If you’re taking this workshop as a class, the toolchains are provided +on the USB disk.

+
+

Static builds of this software are provided for GNU/Linux, macOS, and Windows via +Fomu Toolchain.

+

Debian packages are also available for Raspberry Pi.

+

Moreover, some examples can be executed using Containers.

+
+

Fomu Toolchain

+

To install the software, extract it somewhere on your computer, then +open up a terminal window and add that directory to your PATH:

+
+
export PATH=[path-to-toolchain]/bin:$PATH
+
+
+
+

Examples in VHDL on Fomu and Mixed HDL on Fomu use ghdl-yosys-plugin, +which looks for standard libraries in the path used when GHDL was configured/built. +Therefore, when the toolchain is extracted to an arbitrary location, GHDL_PREFIX +needs to be set:

+
+
export GHDL_PREFIX=[path-to-toolchain]/lib/ghdl
+
+
+
+

To confirm installation, run the yosys command and confirm you get +the following output;

+
$ yosys
+
+ /----------------------------------------------------------------------------\
+ |                                                                            |
+ |  yosys -- Yosys Open SYnthesis Suite                                       |
+ |                                                                            |
+ |  Copyright (C) 2012 - 2018  Clifford Wolf <clifford@clifford.at>           |
+ |                                                                            |
+ |  Permission to use, copy, modify, and/or distribute this software for any  |
+ |  purpose with or without fee is hereby granted, provided that the above    |
+ |  copyright notice and this permission notice appear in all copies.         |
+ |                                                                            |
+ |  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES  |
+ |  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF          |
+ |  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR   |
+ |  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES    |
+ |  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN     |
+ |  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   |
+ |  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.            |
+ |                                                                            |
+ \----------------------------------------------------------------------------/
+
+ Yosys 78b30bbb1102047585d1a2eac89b1c7f5ca7344e (git sha1 41d9173, gcc 5.5.0-12ubuntu1~14.04 -fPIC -Os)
+
+yosys>
+
+
+

Type exit to quit yosys.

+
+

Note

+

See the README of Fomu Toolchain +for a complete list of the tools included in the toolchain.

+
+
+
+

Containers

+

There are several projects which provide ready to use container images including open source EDA tools. +One of those is hdl/containers. +As explained in hdl.github.io/containers: Usage, there are two main +strategies for running EDA tools through containers:

+
    +

  • All-in-one: a single container is used, which includes all the required tools and dependencies. +make and all the tools are executed inside that single container.

    • +

  • Fine-grained: make is executed on the host. For each tool/step, an specific container is used.

    • +
+

Both strategies are supported by the examples in subdir hdl of this repository. +Users willing to run those examples with containers need to take care about the following environment variables:

+
    +

  • GHDL_PLUGIN_MODULE: while ghdl-yosys-plugin is built into Yosys in the fomu-toolchain, it is provided as a module in +most containers. +Typically, GHDL_PLUGIN_MODULE=ghdl is required. +Some specific containers might require GHDL_PLUGIN_MODULE=path/to/ghdl-plugin-name.so.

    • +

  • CONTAINER_ENGINE: in order to enable the fine-grained approach, CONTAINER_ENGINE needs to contain the CLI tool +name of a container engine, such as docker or podman. +This variable needs to be unset for the all-in-one approach. +In that case, the build is agnostic to the fact that everything is being done inside a container.

    +
    +

    Note

    +

    By default, container images defined in hdl/container.mk are used when +CONTAINER_ENGINE is set. +It’s up to the users to customise that file in order to use different container images, or for executing some of the +tools locally.

    +
    +
    • +
+
+

Tip

+

Find both approaches (and environment variables) used in the CI workflow +(.github/workflows/test.yml) of this repository.

+
+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Required Files
+
+ + + arrow_forward +
+ Next +
Required Hardware
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/riscv.html b/riscv.html new file mode 100644 index 0000000..00444ec --- /dev/null +++ b/riscv.html @@ -0,0 +1,575 @@ + + + + + + + + + + + + Fomu as a CPU — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Fomu as a CPU

+

The MicroPython interface is simply a RISC-V program. It interacts with +the RISC-V softcore inside Fomu by reading and writing memory directly.

+

The CPU in Fomu is built on LiteX, which places every device on a +Wishbone bus. This is a 32-bit internal bus that maps peripherals into +memory.

+Fomu peripherals on the Wishbone bus +

If you look at the diagram above, you can see that everything in the +system is on the Wishbone bus. The CPU is a bus master, and can initiate +reads and writes. The system’s RAM is on the wishbone bus, and is +currently located at address 0x10000000. The boot ROM is also on the +bus, and is located at 0x00000000. There is also SPI flash which is +memory-mapped, so when you load your program onto the SPI flash it shows +up on the Wishbone bus at offset 0x20040000.

+

The Configuration and Status Registers (CSRs) all show up at offset +0xe0000000. These are the registers we were accessing from Python. +Just like before, these special memory addresses correspond to control +values.

+

You’ll notice a “Bridge” in the diagram above. This is an optional +feature that we ship by default on Fomu. It bridges the Wishbone bus to +another device. In our case, it makes Wishbone available over USB.

+Wishbone USB debug bridge interface +

The above image shows the structure of a special USB packet we can +generate to access the Wishbone bus from a host PC. It lets us do two +things: Read a 32-bit value from Wishbone, or write a 32-bit value to +Wishbone. These two primitives give us complete control over Fomu.

+

Recall these definitions from earlier:

+
#define CSR_VERSION_MAJOR_ADDR 0xe0007000L
+#define CSR_VERSION_MINOR_ADDR 0xe0007004L
+#define CSR_VERSION_REVISION_ADDR 0xe0007008L
+#define CSR_VERSION_MODEL_ADDR 0xe0007028L
+
+
+

We can use the wishbone-tool program to read these values directly +out of Fomu:

+
wishbone-tool 0xe0007000
+wishbone-tool 0xe0007004
+wishbone-tool 0xe0007008
+
+
+

The three values correspond to the version number of the board at time +of writing: v2.0.3.

+

We can also read and write directly to memory. Recall that memory is +mapped to address 0x10000000. Let’s write a test value there and try +to read it back.

+
wishbone-tool 0x10000000
+wishbone-tool 0x10000000 0x12345678
+wishbone-tool 0x10000000
+
+
+

We can see that the value got stored in memory, just like we thought it +would. The bridge is working, and we have access to Fomu over USB.

+
+

Interacting with the LED Directly

+

Recall the LED block from Python. We used rgb.write_raw() to write +values to the LED block. Because of how the LED block is implemented, we +need to actually make two writes to the Wishbone bus in order to write +one value to the LED block. The first write sets the address, and the +second write sends the actual data.

+

The registers for the LED block are defined as:

+
#define CSR_RGB_DAT_ADDR 0xe0006800
+#define CSR_RGB_ADDR_ADDR 0xe0006804
+
+
+

Let’s change the red color to the maximum value. To do that, we’ll write +a 1 to the address register, and 0xff to the data register:

+
wishbone-tool 0xe0006804 1
+wishbone-tool 0xe0006800 0xff
+
+
+

We can see that the LED immediately changed its behavior. Try playing +around with various values to see what combinations you can come up +with!

+

You can reset Fomu by writing a special value to the CSR_REBOOT_CTRL +register at 0xe0006000L. All writes to this register must start with +0xac, to ensure random values aren’t written. We can reboot Fomu by +simply writing this value:

+
wishbone-tool 0xe0006000 0xac
+
+
+

We can see that wishbone-tool has crashed with an error of +USBError(Pipe), because the USB device went away as we were talking +to it. This is expected behavior. Fomu should be back to its normal +color and blink rate now.

+
+
+

Compiling RISC-V Code

+

Of course, Fomu’s softcore is a full CPU, so we can write C code for it. +Go to the riscv-blink/ directory and run make. This will +generate riscv-blink.dfu, which we can load onto Fomu.

+
make
+dfu-util -D riscv-blink.dfu
+
+
+

This will load the binary onto Fomu and start it immediately. The LED +should be blinking quickly in a rainbow pattern. Congratulations! You’ve +compiled and loaded a RISC-V program onto a softcore.

+

Let’s modify the program by increasing the fade rate so much that it +appears solid. First, reboot Fomu by running +wishbone-tool 0xe0006000 0xac. Next, apply the following patch to +src/main.c:

+
--- a/riscv-blink/src/main.c
++++ b/riscv-blink/src/main.c
+@@ -46,6 +46,7 @@ int main(void) {
+     usb_init();
+     rgb_init();
+     usb_connect();
++    rgb_write((100000/64000)-1, LEDDBR);
+     int i = 0;
+     while (1) {
+         color_wheel(i++);
+
+
+

What this does is increase the LED blink rate from 250 Hz to a much +higher value. Compile this and load it again with +dfu-util -D riscv-blink.bin. The blink rate should appear solid, +because it’s blinking too quickly to see.

+
+
+

Debugging RISC-V Code

+

Because we have peek and poke, and because the USB bridge is a +bus master, we can actually halt (and reset!) the CPU over the USB +bridge. We can go even further and attach a full debugger to it!

+

To start with, run wishbone-tool -s gdb:

+
wishbone-tool -s gdb
+
+
+

In a second window, run gdb on riscv-blink.elf:

+
riscv64-unknown-elf-gdb riscv-blink.elf -ex 'target remote localhost:3333'
+(gdb)
+
+
+

If we run bt we can get a backtrace, and chances are that we landed +in an msleep function:

+
(gdb) bt
+#0  0x2004014c in csr_readl (addr=3758106664) at ./include/hw/common.h:46
+#1  timer0_value_read () at ./include/generated/csr.h:242
+#2  0x200401dc in msleep (ms=ms@entry=80) at ./include/hw/common.h:41
+#3  0x20040074 in main () at ./src/main.c:45
+(gdb)
+
+
+

We can insert breakpoints, step, continue execution, and generally debug +the entire system. We can even reset the program by running +mon reset.

+
+
+

Using Rust

+

As an alternative to C, the Rust Language can be used to write software for the Fomu softcore. +To install Rust, follow the instructions on https://rustup.rs/. After installing Rust, we can install support for RISCV +targets using rustup:

+
rustup target add riscv32i-unknown-none-elf
+
+
+

A Rust version of the C program used above is located in the riscv-rust-blink directory. Change into that directory, +and build it using cargo, the Rust package manager:

+
cargo build --release
+
+
+

The resulting binary is located in the target subfolder: target/riscv32i-unknown-none-elf/release/riscv-rust-blink. It can +be flashed using the flash.sh script, also located in the riscv-rust-blink folder:

+
./flash.sh
+
+
+

Now the Fomu should blink in the same rainbow pattern as before.

+
+

Warning

+

The Rust example currently does not support the USB functionality. After programming the example, we will not be able to +acces the Fomu over USB anymore. To enable USB again, we have to reset the Fomu by removing it from the USB port and +plugging it in again.

+
+
+
+

Further RISC-V experiments

+

The TinyUSB USB stack supports Fomu. To get started with it, you might compile the mass storage example it provides. To do so, follow these steps:

+
    +

  • Clone the TinyUSB git repository: git clone https://github.com/hathach/tinyusb (you don’t need to initialize the subrepositories)

    • +

  • Change to tinyusb/examples/device/cdc_msc

    • +

  • Compile: make BOARD=fomu CROSS_COMPILE=riscv64-unknown-elf-

    • +

  • Load it onto the Fomu: dfu-util -D _build/fomu/cdc_msc.bin

    • +
+

Fomu should now appear as a USB storage device containing a README.

+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Python on Fomu
+
+ + + arrow_forward +
+ Next +
Hardware Description Languages
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 0000000..7c14bc3 --- /dev/null +++ b/search.html @@ -0,0 +1,255 @@ + + + + + + + + + + + Search — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +

Search

+
+ +

+ Please activate JavaScript to enable the search + functionality. +

+
+

+ From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +

+
+
+ + +
+ + +
+ +
+ +
+ +
+
+
+
+
+ +
+
+
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 0000000..63a2a97 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["background", "bootloader", "hdl", "help", "icestudio", "index", "migen", "mixed-hdl", "python", "renode", "renode-bridge", "renode-starting", "renode-verilator", "renode-zephyr", "requirements/drivers", "requirements/files", "requirements/hardware", "requirements/index", "requirements/software", "riscv", "verilog", "vhdl"], "filenames": ["background.rst", "bootloader.rst", "hdl.rst", "help.rst", "icestudio.rst", "index.rst", "migen.rst", "mixed-hdl.rst", "python.rst", "renode.rst", "renode-bridge.rst", "renode-starting.rst", "renode-verilator.rst", "renode-zephyr.rst", "requirements/drivers.rst", "requirements/files.rst", "requirements/hardware.rst", "requirements/index.rst", "requirements/software.rst", "riscv.rst", "verilog.rst", "vhdl.rst"], "titles": ["Background", "Bootloader", "Hardware Description Languages", "Getting Help", "Fomu on IceStudio Nightly", "FPGA Tomu Workshop", "Migen and LiteX", "Mixed HDL on Fomu", "Python on Fomu", "Working with LiteX and (co-)simulation with Renode", "Wishbone bridge between Renode and Fomu", "Getting Renode", "Renode Co-simulation using Verilator", "Running your own Zephyr binary on LiteX/VexRiscv in Renode", "Required Drivers", "Required Files", "Required Hardware", "Requirements", "Required Software", "Fomu as a CPU", "Verilog on Fomu", "VHDL on Fomu"], "terms": {"field": [0, 14], "programm": 0, "arrai": 0, "ar": [0, 2, 4, 5, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21], "integr": [0, 9], "circuit": 0, "contain": [0, 4, 6, 7, 8, 9, 17, 19, 20, 21], "which": [0, 2, 4, 6, 9, 10, 11, 12, 17, 18, 19, 20], "most": [0, 2, 14, 18], "chip": 0, "you": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21], "encount": 0, "have": [0, 1, 2, 4, 6, 8, 11, 12, 13, 17, 19], "transistor": 0, "arrang": 0, "fix": 0, "order": [0, 6, 16, 18, 19], "thu": 0, "provid": [0, 2, 6, 10, 12, 15, 18, 19], "function": [0, 8, 9, 12, 19], "convers": 0, "can": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21], "chang": [0, 4, 8, 10, 19], "intern": [0, 19], "connect": [0, 3, 6, 8, 9, 12, 13, 18], "simpli": [0, 6, 12, 19], "new": [0, 3, 6, 8, 10, 12, 13], "configur": [0, 9, 10, 18, 19], "fundament": 0, "program": [0, 2, 8, 19], "lookup": 0, "tabl": 0, "lut": 0, "form": 0, "basic": [0, 2, 5, 13], "build": [0, 4, 6, 7, 9, 12, 18, 19, 20, 21], "block": [0, 2, 4, 6, 8, 19], "logic": 0, "These": [0, 8, 12, 16, 19], "so": [0, 2, 4, 5, 6, 7, 8, 17, 18, 19, 20, 21], "import": [0, 6, 8], "design": [0, 2, 4, 6, 12, 16], "usag": [0, 2, 8, 9, 12, 18], "an": [0, 1, 2, 4, 6, 7, 8, 9, 10, 12, 14, 17, 18, 19, 20, 21], "thei": [0, 8, 12, 15, 16], "usual": [0, 13], "part": [0, 6, 10, 12, 16], "name": [0, 2, 4, 10, 14, 18], "For": [0, 4, 7, 8, 12, 13, 16, 17, 18], "exampl": [0, 1, 2, 4, 6, 7, 8, 10, 12, 18, 19, 20, 21], "us": [0, 2, 3, 4, 6, 7, 8, 9, 10, 11, 13, 14, 16, 18, 20, 21], "up5k": [0, 4], "ha": [0, 1, 2, 8, 12, 16, 19], "5000": 0, "netv": 0, "lx9": 0, "had": [0, 6], "9000": 0, "netv2": 0, "xc7a35t": 0, "35000": 0, "almost": 0, "alwai": [0, 4], "n": 0, "input": [0, 2], "1": [0, 6, 19, 20], "output": [0, 1, 2, 4, 6, 18], "The": [0, 2, 4, 6, 7, 8, 10, 12, 13, 17, 19, 20, 21], "ic": [0, 4], "famili": 0, "from": [0, 1, 2, 4, 6, 8, 9, 11, 13, 14, 16, 17, 18, 19], "lattic": [0, 8], "4": [0, 13, 20], "xilinx": 0, "tend": 0, "5": [0, 13, 18], "6": [0, 19], "gener": [0, 4, 6, 8, 13, 19], "mean": [0, 2, 9, 12], "do": [0, 2, 4, 6, 10, 14, 17, 19], "more": [0, 2, 4, 8, 12, 16], "fewer": 0, "compar": [0, 4, 7], "count": 0, "between": [0, 2, 8, 9], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 17, 18, 19, 20, 21], "bit": [0, 6, 19], "like": [0, 3, 5, 10, 12, 13, 14, 17, 19, 20], "clock": [0, 2, 7, 20, 21], "speed": 0, "differ": [0, 2, 3, 8, 16, 18], "cpu": [0, 6, 10], "entir": [0, 19], "accur": [0, 9], "certainli": 0, "help": [0, 2, 10], "rule": [0, 2, 16, 17], "thumb": 0, "ice40": [0, 2, 8], "lut4": 0, "sb_lut4": 0, "It": [0, 2, 6, 7, 8, 9, 13, 16, 18, 19], "four": [0, 2], "one": [0, 11, 12, 13, 16, 18, 19], "To": [0, 1, 6, 10, 11, 12, 13, 18, 19], "we": [0, 2, 5, 6, 7, 8, 9, 10, 12, 19, 20, 21], "must": [0, 2, 8, 14, 19], "defin": [0, 2, 4, 6, 8, 18, 19], "what": [0, 5, 8, 12, 17, 19], "each": [0, 2, 4, 8, 12, 18], "possibl": [0, 2, 12], "pattern": [0, 4, 7, 9, 19, 20, 21], "creat": [0, 6, 10, 14], "thi": [0, 1, 2, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 16, 17, 18, 19, 20, 21], "truth": 0, "0": [0, 1, 6, 8, 10, 17, 18, 19], "2": [0, 6, 19, 20], "3": [0, 1, 6, 17, 19, 20], "7": [0, 19], "8": 0, "9": 0, "10": [0, 8, 14], "11": 0, "12": [0, 2], "13": 0, "14": [0, 18], "15": 0, "io0": 0, "io1": 0, "io2": 0, "io3": 0, "o": [0, 2, 4, 10, 18], "act": [0, 10], "AND": [0, 18], "would": [0, 2, 10, 19], "everyth": [0, 11, 18, 19], "except": 0, "last": 0, "column": 0, "nand": 0, "simpl": [0, 8], "primit": [0, 19], "plb": 0, "diagram": [0, 2, 19], "modern": 0, "longer": 0, "compos": 0, "e": [0, 2, 10, 12], "onli": [0, 2, 12, 14], "typic": [0, 12, 18], "group": [0, 8, 14], "flip": 0, "flop": 0, "regist": [0, 5, 6, 10, 19], "dff": 0, "some": [0, 2, 8, 10, 12, 13, 16, 18, 20], "carri": 0, "call": [0, 2, 8, 10, 11, 12], "clb": 0, "depend": [0, 2, 13, 18], "vendor": 0, "resourc": 0, "allow": [0, 2, 4, 10, 12], "combin": [0, 7, 19], "multipl": 0, "describ": [0, 2, 6, 9, 20], "larger": 0, "sequenti": 0, "behaviour": 0, "furthermor": 0, "addit": [0, 8, 10, 13, 14], "purpos": [0, 18], "specif": [0, 4, 18], "includ": [0, 3, 6, 9, 10, 12, 18, 19], "ram": [0, 6, 19], "bram": 0, "digit": 0, "signal": [0, 6, 12], "process": [0, 8], "dsp": 0, "high": 0, "perform": [0, 2, 18], "serial": [0, 8, 13], "transmitt": 0, "receiv": [0, 16], "etc": [0, 3, 14], "those": [0, 9, 18], "hard": [0, 2, 21], "better": [0, 7], "area": [0, 8], "power": 0, "than": [0, 8, 14, 17], "base": [0, 3, 10, 12], "compon": [0, 2, 7, 12, 16, 21], "nevertheless": 0, "ani": [0, 2, 5, 7, 10, 14, 16, 18], "replic": 0, "At": [0, 16], "same": [0, 4, 7, 19, 20, 21], "time": [0, 2, 5, 8, 10, 19], "custom": 0, "through": [0, 2, 4, 18], "becaus": [0, 2, 12, 19], "all": [0, 2, 6, 8, 9, 10, 12, 13, 14, 18, 19], "within": 0, "pre": 0, "other": [0, 7, 9, 12, 13, 18], "manual": [0, 9, 10, 12], "veri": [0, 2, 6, 9, 10, 13], "challeng": [0, 2], "peopl": 0, "come": [0, 6, 11, 19], "up": [0, 2, 6, 9, 11, 12, 13, 17, 18, 19], "abstract": [0, 2, 6, 12], "hardwar": [0, 4, 5, 6, 7, 8, 9, 12, 17, 20, 21], "descript": [0, 6, 16], "languag": [0, 6, 7, 19], "hdl": [0, 2, 4, 6, 12, 18, 20, 21], "u": [0, 2, 6, 10, 19], "expect": [0, 2, 19], "structur": [0, 19], "two": [0, 2, 18, 19], "common": [0, 2, 19], "verilog": [0, 2, 4, 6, 7], "vhdl": [0, 2, 6, 7, 18], "howev": [0, 4, 7, 14], "trend": 0, "achiev": [0, 2], "embed": [0, 6], "domain": [0, 2], "dsl": 0, "insid": [0, 18, 19], "exist": [0, 8], "how": [0, 2, 4, 5, 9, 12, 19, 20], "migen": [0, 2], "python": [0, 5, 6, 13, 19], "clash": 0, "haskel": 0, "chisel": 0, "spinalhdl": 0, "scala": 0, "here": [0, 8], "counter": 0, "modul": [0, 2, 4, 6, 7, 8, 18], "c": [0, 12, 18, 19], "reg": 0, "q": 0, "posedg": 0, "begin": [0, 4], "b1": 0, "end": [0, 12, 16], "endmodul": 0, "run": [0, 1, 2, 6, 8, 9, 10, 11, 12, 14, 16, 17, 18, 19], "synthes": [0, 10], "familiar": [0, 7], "A": [0, 4, 8, 11, 12, 17, 19], "synthesi": [0, 2, 18], "abov": [0, 4, 8, 10, 11, 12, 18, 19, 20], "If": [0, 1, 3, 6, 7, 8, 10, 14, 15, 16, 17, 18, 19], "decid": [0, 2, 12], "pile": 0, "need": [0, 4, 6, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "strung": 0, "togeth": [0, 12], "somehow": 0, "done": [0, 2, 13, 18], "place": [0, 2, 4, 19], "rout": [0, 2, 4], "pnr": [0, 2], "tool": [0, 2, 6, 10, 17, 18, 19], "job": 0, "assign": [0, 4, 6], "physic": [0, 10, 13], "get": [0, 6, 7, 8, 9, 13, 14, 17, 18, 19, 20, 21], "figur": 0, "out": [0, 2, 5, 6, 8, 9, 10, 14, 18, 19, 20], "wire": [0, 6], "onc": [0, 2], "file": [0, 1, 6, 7, 8, 9, 13, 14, 17, 18], "translat": 0, "format": [0, 4], "recogn": 0, "pack": 0, "final": [0, 4, 5, 6], "onto": [0, 6, 7, 8, 19, 20, 21], "toggl": 0, "interfac": [0, 9, 10, 12, 19], "volatil": 0, "lost": 0, "when": [0, 2, 4, 5, 6, 18, 19], "unplug": 0, "therefor": [0, 4, 18], "board": [0, 1, 2, 8, 10, 13, 14, 16, 17, 19], "flash": [0, 1, 8, 10, 19, 20], "memori": [0, 6, 10, 19], "spi": [0, 8, 10, 19], "Then": [0, 11], "plug": [0, 19], "again": [0, 4, 8, 14, 19], "predefin": [0, 4, 8], "locat": [0, 6, 8, 15, 18, 19], "workshop": [0, 2, 3, 8, 10, 15, 16, 17, 18], "number": [0, 2, 7, 8, 19, 20, 21], "nice": 0, "featur": [0, 3, 4, 6, 19], "5280": 0, "lc": 0, "16": 0, "kilobyt": [0, 6], "128": [0, 6], "spram": 0, "1x": 0, "current": [0, 2, 4, 12, 19], "limit": [0, 2], "channel": 0, "led": [0, 2, 8, 10], "driver": [0, 2, 6, 16, 17], "2x": 0, "i2c": 0, "8x": 0, "unit": 0, "warmboot": 0, "capabl": [0, 9, 10, 12, 13], "open": [0, 4, 8, 9, 14, 18], "toolchain": [0, 2, 13, 17], "top": [0, 4, 5, 6, 12], "view": [0, 4], "frequent": 0, "store": [0, 19], "data": [0, 18, 19], "buffer": 0, "larg": [0, 7, 16, 20, 21], "type": [0, 1, 10, 11, 12, 13, 17, 18], "reus": [0, 6], "mani": [0, 8, 9], "unusu": 0, "also": [0, 2, 4, 6, 8, 9, 10, 12, 13, 16, 18, 19], "singl": [0, 7, 8, 11, 12, 13, 18], "port": [0, 2, 8, 13, 14, 16, 19, 20], "softcor": [0, 2, 19], "term": [0, 8], "core": [0, 2, 21], "differenti": 0, "implement": [0, 2, 6, 8, 12, 19], "That": [0, 2], "unlik": 0, "valuabl": 0, "isn": 0, "t": [0, 2, 8, 10, 12, 19], "taken": 0, "system": [0, 6, 10, 12, 13, 14, 19], "addition": 0, "support": [0, 4, 9, 12, 13, 18, 19], "enabl": [0, 10, 18, 19, 20], "live": 0, "tell": 0, "swap": 0, "them": [0, 2, 6, 11], "As": [0, 2, 4, 6, 18, 19], "wouldn": 0, "nearli": 0, "easi": 0, "without": [0, 2, 18], "sourc": [0, 7, 9, 10, 11, 12, 13, 18], "lot": [0, 6], "platform": [0, 6, 9, 10], "fit": [0, 10, 16, 18], "your": [0, 1, 2, 6, 7, 8, 9, 11, 12, 14, 17, 18, 19, 20, 21], "usb": [0, 2, 4, 6, 8, 10, 14, 15, 16, 18, 19, 20], "megabyt": 0, "edg": 0, "button": [0, 4, 8], "three": [0, 2, 6, 8, 11, 19], "color": [0, 7, 8, 16, 19, 20, 21], "project": [0, 4, 7, 18, 20, 21], "its": [0, 2, 4, 12, 19], "abil": [0, 2], "commun": [0, 2, 4, 10, 12], "over": [0, 2, 19], "storag": [0, 6, 19], "small": [0, 8, 16, 20], "tini": [0, 2], "factor": 0, "let": [0, 2, 6, 9, 19], "realli": [0, 6, 8], "cool": 0, "thing": [0, 2, 5, 8, 19], "heart": 0, "control": [0, 8, 9, 10, 19], "try": [0, 6, 7, 8, 9, 14, 19], "unlock": [0, 4], "section": [0, 9, 13, 17], "were": [0, 16, 19], "extract": [0, 18], "ultraplu": [0, 2], "sheet": 0, "download": [1, 14, 15], "appropri": 1, "dfu": [1, 6, 7, 8, 14, 16, 17, 19, 20, 21], "releas": [1, 4, 19], "foboot": [1, 17], "v2": [1, 17, 19], "pvt": [1, 16], "hacker": [1, 8, 16], "util": [1, 6, 7, 8, 14, 17, 19, 20, 21], "d": [1, 2, 6, 7, 14, 19, 20, 21], "version": [1, 8, 13, 17, 19], "rainbow": [1, 4, 19], "about": [1, 2, 4, 6, 16, 18], "five": [1, 2], "second": [1, 4, 8, 19], "reboot": [1, 19], "go": [1, 4, 6, 19], "back": [1, 4, 16, 19], "blink": [1, 2, 8, 19], "verifi": [1, 4, 11, 12], "l": [1, 2, 14, 17], "check": [1, 4, 6, 14], "session": 1, "product": [1, 8, 16], "h": [2, 8, 12, 19], "ardwar": 2, "escript": 2, "anguag": 2, "explain": [2, 6, 18], "turn": [2, 10], "code": [2, 4, 6, 8, 9, 10], "gate": 2, "convert": [2, 8], "human": 2, "readabl": 2, "netlist": 2, "represent": 2, "fomu": [2, 5, 6, 9, 13, 14, 15, 17], "yosi": [2, 18], "nextpnr": 2, "oper": [2, 12, 13], "make": [2, 7, 10, 12, 16, 18, 19, 20, 21], "someth": [2, 6], "actual": [2, 6, 8, 19], "fpga": [2, 10, 12], "makefil": [2, 7], "subdirectori": 2, "follow": [2, 3, 7, 8, 10, 11, 13, 14, 17, 18, 19], "mix": [2, 18], "driven": 2, "given": [2, 10, 20], "guarante": 2, "fast": 2, "enough": [2, 11], "sometim": 2, "won": [2, 10], "optimis": 2, "further": 2, "command": [2, 4, 7, 8, 10, 11, 13, 16, 18, 20, 21], "see": [2, 4, 6, 7, 8, 9, 10, 11, 12, 13, 16, 17, 18, 19, 20, 21], "similar": 2, "info": [2, 4], "max": 2, "frequenc": 2, "clk": [2, 12], "73": 2, "26": 2, "mhz": [2, 7, 20, 21], "pass": 2, "00": [2, 10], "show": [2, 19, 20], "could": 2, "still": [2, 6], "stabl": [2, 4], "even": [2, 9, 19], "though": [2, 16], "request": [2, 6], "note": [2, 10, 12], "variat": 2, "placer": 2, "router": 2, "lai": 2, "exact": 2, "might": [2, 8, 18, 19], "ones": [2, 21], "shown": [2, 4, 8], "document": [2, 4, 9, 10, 13], "bitstream": [2, 4, 7, 20, 21], "tradeoff": 2, "size": [2, 16], "unfortun": 2, "straightforward": 2, "non": [2, 8, 14, 16], "trivial": 2, "henc": 2, "whether": [2, 18], "behav": 2, "ideal": 2, "uart": [2, 10, 11, 12], "user": [2, 8, 9, 12, 14, 18], "instanti": [2, 6, 21], "should": [2, 4, 6, 7, 8, 11, 12, 13, 14, 16, 17, 19, 20, 21], "interest": [2, 12], "know": 2, "meanwhil": 2, "litex": [2, 10, 19], "work": [2, 6, 8, 11, 13, 16, 19], "soc": [2, 6, 9, 10], "interact": [2, 8, 10, 13], "wishbon": [2, 9, 19], "bu": [2, 12, 19], "ultralit": 2, "rgb": [2, 6, 19], "level": [2, 8], "regardless": 2, "higher": [2, 19], "drive": [2, 15], "sb_rgba_drv": [2, 6], "datasheet": 2, "curren": 2, "rgbleden": 2, "rgb0pwm": 2, "rgb1pwm": 2, "rgb2pwm": 2, "rgb0": 2, "rgb1": 2, "rgb2": 2, "paramet": 2, "current_mod": 2, "rgb0_current": 2, "rgb1_current": 2, "rgb2_current": 2, "result": [2, 4, 7, 13, 18, 19], "safe": 2, "specifi": 2, "inform": [2, 8], "found": [2, 8, 21], "guid": [2, 8, 13], "directli": [2, 10, 16], "strongli": [2, 7], "discourag": 2, "damag": [2, 18], "hello": 2, "world": [2, 5], "read": [2, 6, 8, 12, 19], "extens": 2, "icestudio": 2, "nightli": 2, "navig": 2, "stuck": 3, "anywher": 3, "internet": 3, "relai": 3, "old": 3, "school": 3, "befor": [3, 6, 7, 11, 13, 16, 19], "slack": 3, "becam": 3, "popular": 3, "wide": [3, 6], "rang": [3, 8], "client": 3, "web": 3, "irccloud": 3, "tomu": 3, "freenod": 3, "net": [3, 11], "webchat": 3, "log": [3, 4, 8, 10, 12, 14], "latest": 3, "announc": 3, "low": 3, "traffic": 3, "discuss": 3, "develop": [3, 4, 9, 12, 13], "canon": [4, 7, 20, 21], "directori": [4, 6, 7, 12, 15, 18, 19, 20, 21], "blinki": 4, "moreov": [4, 18], "blinky_boardtop": 4, "wrap": 4, "showcas": 4, "under": [4, 8, 12, 14, 15], "test": [4, 12, 18, 19], "dut": 4, "black": 4, "box": 4, "botton": 4, "select": [4, 8, 14], "click": 4, "microchip": 4, "icon": 4, "modal": 4, "window": [4, 8, 10, 11, 12, 13, 14, 18, 19], "There": [4, 6, 8, 11, 16, 18, 19, 20], "devic": [4, 8, 10, 14, 16, 19], "first": [4, 5, 8, 10, 12, 17, 19], "dropdown": [4, 8, 14], "list": [4, 8, 10, 14, 18], "export": [4, 16], "synthesis": 4, "upload": 4, "send": [4, 19], "after": [4, 10, 19], "step": [4, 17, 18, 19], "execut": [4, 6, 13, 18, 19], "correspond": [4, 6, 8, 19], "soon": 4, "finish": 4, "": [4, 6, 8, 9, 10, 11, 12, 18, 19], "just": [4, 6, 9, 10, 13, 19], "trip": 4, "hierarchi": 4, "doubl": 4, "main": [4, 12, 18, 19], "deep": [4, 5], "want": [4, 10, 12, 13], "until": [4, 5], "find": [4, 7, 10, 12, 18], "raw": 4, "observ": [4, 9], "fanci": 4, "wrapper": [4, 8], "around": [4, 19], "edit": 4, "submodul": [4, 6], "default": [4, 7, 10, 18, 19], "red": [4, 19, 20], "left": 4, "modif": 4, "wish": 4, "save": 4, "home": 4, "bottom": 4, "jump": 4, "root": [4, 8], "straightawai": 4, "independ": [4, 12], "instanc": [4, 6, 8], "instead": [4, 8, 9], "browsabl": 4, "screencast": 4, "pin": [4, 20], "disconnect": 4, "stack": [4, 19], "writ": 4, "necessari": [4, 10], "set": [4, 6, 9, 12, 13, 17, 18, 19, 20, 21], "usb_dn": 4, "usb_dp": 4, "usb_dp_pu": 4, "option": [4, 14, 19], "doe": [4, 14, 19], "cleaner": 4, "graphic": 4, "dese": 4, "blinky_boardtop_rul": 4, "explicitli": 4, "ensur": [4, 6, 19], "activ": 4, "properti": 4, "inpect": 4, "appli": [4, 19], "lower": 4, "blinky_rul": 4, "collect": 4, "plugin": [4, 12, 18], "hi": 5, "m": [5, 19], "cover": 5, "down": [5, 7, 20, 21], "approach": [5, 18], "ll": [5, 10, 12, 16, 19], "start": [5, 10, 11, 12, 13, 19], "learn": 5, "load": [5, 6, 7, 8, 10, 12, 19, 20, 21], "softwar": [5, 9, 11, 12, 13, 16, 17, 19], "write": [5, 6, 8, 10, 12, 19], "complex": [5, 10], "weird": 5, "take": [5, 6, 7, 8, 9, 10, 12, 14, 18, 20, 21], "gentl": 5, "treat": 5, "interpret": 5, "gradual": 5, "peel": 5, "awai": [5, 19], "layer": [5, 6, 12], "re": [5, 8, 15, 18], "our": [5, 6, 19], "own": [5, 9, 11], "break": 5, "explor": [5, 9], "stop": 5, "feel": 5, "concept": 5, "too": [5, 19], "unfamiliar": 5, "plough": 5, "dig": 5, "written": [6, 7, 16, 19], "py": 6, "expand": [6, 12, 20], "respect": [6, 10, 11], "fomu_rev": [6, 16, 20, 21], "environ": [6, 9, 12, 13, 18], "variabl": [6, 7, 12, 13, 18], "correctli": 6, "bin": [6, 19], "ident": 6, "reason": 6, "bridg": [6, 9, 19], "dummyusb": 6, "respond": 6, "reli": 6, "local": [6, 18], "error": [6, 8, 14, 19], "messag": [6, 14], "miss": 6, "clone": [6, 15, 19], "setup": [6, 10, 12, 17], "look": [6, 7, 8, 9, 10, 12, 18, 19], "csr": [6, 19], "csv": 6, "variou": [6, 19], "region": 6, "present": [6, 17], "memory_region": 6, "sram": [6, 10], "0x10000000": [6, 10, 19], "131072": 6, "indic": [6, 7, 8, 20, 21], "long": [6, 10, 12], "timer": 6, "asid": [6, 16], "much": [6, 19], "But": 6, "infrastructur": [6, 12], "add": [6, 12, 14, 18], "workshop_rgb": 6, "complet": [6, 11, 12, 18, 19], "class": [6, 8, 12, 18], "fomurgb": 6, "autocsr": 6, "def": 6, "__init__": 6, "self": 6, "pad": 6, "csrstorag": 6, "special": [6, 8, 12, 14, 16, 18, 19], "i_curren": 6, "0b1": 6, "i_rgbleden": 6, "i_rgb0pwm": 6, "i_rgb1pwm": 6, "i_rgb2pwm": 6, "o_rgb0": 6, "r": [6, 19], "o_rgb1": 6, "g": [6, 10, 12], "o_rgb2": 6, "b": [6, 13, 19], "p_current_mod": 6, "p_rgb0_current": 6, "0b000011": 6, "p_rgb1_current": 6, "p_rgb2_current": 6, "object": [6, 10], "By": [6, 18], "deriv": [6, 12], "accessor": 6, "method": 6, "ad": [6, 8], "automat": 6, "led_pad": 6, "rgb_led": 6, "fomu_rgb": 6, "csr_map": 6, "add_csr": 6, "now": [6, 9, 10, 19], "rebuild": 6, "csr_regist": 6, "fomu_rgb_output": 6, "0x60003000": 6, "rw": 6, "valu": [6, 8, 10, 19, 20, 21], "whatev": 6, "sai": 6, "effect": [6, 10], "immedi": [6, 8, 19], "littl": 6, "expos": [6, 20], "suggest": 7, "tinker": 7, "case": [7, 16, 18, 19], "48": [7, 20, 21], "divid": [7, 20, 21], "off": [7, 10, 20, 21], "enter": [7, 20, 21], "demo": [7, 9, 13, 20, 21], "ve": [7, 19, 20, 21], "been": [7, 20, 21], "far": [7, 20, 21], "vari": [7, 8, 20, 21], "wa": [7, 18, 20, 21], "successfulli": [7, 20, 21], "closer": 7, "clkgen": 7, "both": [7, 9, 18], "vhd": [7, 21], "v": [7, 8, 9, 12, 13, 16], "produc": 7, "modifi": [7, 8, 18, 19], "vhdl_syn_fil": 7, "verilog_syn_fil": 7, "understand": 7, "solut": 7, "micropython": [8, 19], "ordinari": 8, "risc": [8, 9, 12, 13, 16], "binari": [8, 9, 11, 19], "precompil": [8, 9], "maco": [8, 11, 13, 14, 18], "x": [8, 14, 16, 18], "linux": [8, 9, 11, 13, 14, 16, 18], "machin": [8, 10], "ttyacm": 8, "unabl": 8, "mai": [8, 13, 14, 15, 16], "sudo": [8, 14, 16], "access": [8, 10, 14, 16, 19], "unless": [8, 14], "grant": [8, 14, 16, 18], "permiss": [8, 14, 16, 18], "privileg": [8, 14, 16], "account": [8, 14, 16], "dialout": 8, "full": [8, 9, 10, 12, 19], "direct": [8, 18], "affect": [8, 14], "earlier": [8, 14, 19], "instal": [8, 11, 12, 13, 17, 18, 19, 21], "zadag": 8, "cdc": 8, "tera": 8, "In": [8, 11, 12, 13, 14, 16, 18, 19], "teraterm": 8, "hit": [8, 14], "radio": 8, "grei": 8, "greet": 8, "banner": 8, "repl": 8, "fulli": [8, 9], "shell": [8, 10, 13], "print": 8, "hex": 8, "9876": 8, "1234": [8, 10], "few": [8, 9], "extend": 8, "mode": [8, 14], "id": [8, 14], "model": [8, 12, 16], "good": 8, "kind": [8, 12], "header": 8, "riscv": [8, 19], "major": 8, "minor": 8, "revis": 8, "csr_version_major_addr": [8, 19], "0xe0007000": [8, 10], "csr_version_minor_addr": [8, 19], "0xe0007004": 8, "csr_version_revision_addr": [8, 19], "0xe0007008": 8, "csr_version_model_addr": [8, 19], "0xe0007028": 8, "don": [8, 19], "charact": 8, "p": [8, 13], "below": [8, 13, 16], "fade": [8, 10, 19], "puls": 8, "simplifi": 8, "argument": 8, "leddpwr": 8, "determin": 8, "bright": 8, "255": 8, "soft": 9, "robust": 9, "scalabl": 9, "bare": 9, "metal": 9, "zephyr": [9, 10], "framework": [9, 11], "unmodifi": 9, "inspect": [9, 12], "aim": 9, "mimic": 9, "behavior": [9, 19], "cycl": 9, "blown": 9, "rto": [9, 13], "hw": [9, 19], "sw": 9, "workflow": [9, 18], "apart": 9, "architectur": [9, 13], "tutori": [9, 13], "video": 9, "websit": 9, "keep": [9, 12], "mind": [9, 12], "text": [9, 16], "config": 9, "detail": [9, 12, 13], "quickli": [9, 19], "vexriscv": [9, 10], "applic": [9, 10], "app": 9, "debug": [9, 10, 12], "server": 9, "veril": 9, "etherbon": 10, "peripher": [10, 12, 19], "map": [10, 19], "space": 10, "via": [10, 12, 18], "protocol": 10, "potenti": 10, "simul": 10, "advanc": 10, "normal": [10, 19], "remain": 10, "localhost": 10, "monitor": [10, 11, 12, 13], "script": [10, 11, 12, 13, 19], "renode_etherbone_fomu": 10, "resc": [10, 11, 12, 13], "emul": 10, "sysbu": [10, 12], "logperipheralaccess": [10, 12], "led_toggl": 10, "led_breath": 10, "slowli": 10, "breath": 10, "issu": 10, "01": 10, "31": 10, "8276": 10, "0x40000988": 10, "writeuint32": 10, "0x8": 10, "unknown": [10, 13, 19], "0x7": 10, "8279": 10, "0x40000990": 10, "0x4": 10, "8290": 10, "0x40000998": 10, "0x0": 10, "0xc8": 10, "8298": 10, "0x400009a0": 10, "0x9": 10, "8301": 10, "0x400009a8": 10, "0xba": 10, "8305": 10, "0x400009b0": 10, "0x6": 10, "8308": 10, "0x400009b4": 10, "8311": 10, "0x400009bc": 10, "0x5": 10, "8314": 10, "0x400009c0": 10, "8317": 10, "0x400009c4": 10, "8321": 10, "0x400009c8": 10, "8324": 10, "0x400009d0": 10, "0x2": 10, "8327": 10, "0x400009d4": 10, "8331": 10, "0x400009dc": 10, "0x3": 10, "8334": 10, "0x400009e0": 10, "8337": 10, "0x400009e8": 10, "0x1": 10, "8341": 10, "0x400009f4": 10, "0xff": [10, 19], "8344": 10, "0x40000a08": 10, "0xa": 10, "8347": 10, "0x40000a0c": 10, "8350": 10, "0x40000a14": 10, "0xb": 10, "8353": 10, "0x40000a18": 10, "serv": 10, "element": [10, 12], "etherbonebridg": 10, "entri": [10, 19], "avail": [10, 11, 12, 15, 18, 19], "systembu": 10, "slot": 10, "ddr": 10, "mappedmemori": 10, "0x40000000": 10, "0x4fffffff": 10, "0xc0000000": 10, "0xcfffffff": 10, "eth": 10, "litex_ethernet": 10, "0x60007800": 10, "0x600078ff": 10, "0xe0007800": 10, "0xe00078ff": 10, "0x30000000": 10, "0x30001fff": 10, "0xb0000000": 10, "0xb0001fff": 10, "0x60007000": 10, "0x600077ff": 10, "0xe00077ff": 10, "phy": 10, "ethernetphysicallay": 10, "address": [10, 19], "flash_mem": 10, "0x20000000": 10, "0x21ffffff": 10, "0xa0000000": 10, "0xa1ffffff": 10, "0xe0006800": [10, 19], "0xe00068ff": 10, "mem": 10, "0x00000000": [10, 19], "0x0003ffff": 10, "0x80000000": 10, "0x8003ffff": 10, "litex_spi_flash": 10, "0x60005000": 10, "0x6000500f": 10, "0xe0005000": 10, "0xe000500f": 10, "micron_mt25q": 10, "0x1003ffff": 10, "0x90000000": 10, "0x9003ffff": 10, "timer0": 10, "litex_tim": 10, "0x60002800": 10, "0x60002843": 10, "0xe0002800": 10, "0xe0002843": 10, "litex_uart": 10, "0x60001800": 10, "0x600018ff": 10, "0xe0001800": 10, "0xe00018ff": 10, "connector": 10, "either": [10, 11, 12], "rel": 10, "writedoubleword": 10, "0xe0006804": [10, 19], "0x1234": 10, "0x4321": 10, "statu": [10, 19], "visibl": 10, "wai": 10, "sequenc": 10, "On": [11, 13, 14], "mono": 11, "comput": [11, 16, 18], "instruct": [11, 13, 19], "packag": [11, 18, 19], "fairli": 11, "recent": 11, "prebuilt": 11, "compil": [11, 12, 13], "yourself": 11, "sever": [11, 12, 18], "litex_vexriscv_micropython": 11, "litex_vexriscv_zephyr": [11, 13], "litex_vexriscv_linux": 11, "built": [11, 13, 18, 19], "termin": [11, 18], "pop": [11, 13], "cli": [11, 18], "node": [11, 12, 13], "script_nam": 11, "where": [11, 13], "voila": 11, "analyz": [11, 12], "appear": [11, 18, 19], "boot": [11, 19], "while": [12, 18, 19], "real": 12, "give": [12, 14, 19], "gatewar": 12, "anoth": [12, 19, 20], "scenario": 12, "consist": 12, "itself": 12, "librari": [12, 18], "shim": 12, "axilit": 12, "due": 12, "natur": 12, "doesn": 12, "matter": 12, "tree": 12, "alreadi": 12, "prepar": [12, 13], "riscv_verilated_uartlit": 12, "uartlit": 12, "whatperipheralisat": 12, "0x70000000": 12, "antmicro": 12, "verilateduart": 12, "everi": [12, 19], "displai": 12, "pleas": [12, 17], "despit": 12, "being": [12, 18], "nativ": 12, "line": 12, "tx": 12, "rx": 12, "github": [12, 15, 18, 19], "zeromq": 12, "libzmq3": 12, "dev": 12, "debian": [12, 18], "path": [12, 13, 18], "src": [12, 19], "verilatorplugin": 12, "verilatorintegrationlibrari": 12, "integration_dir": 12, "copi": [12, 18], "With": 12, "easili": 12, "standard": [12, 18], "well": [12, 13], "briefli": 12, "sim": 12, "cpp": 12, "buse": 12, "declar": [12, 21], "handl": 12, "transact": 12, "void": [12, 19], "init": 12, "rst": 12, "awaddr": 12, "unsign": 12, "awvalid": 12, "awreadi": 12, "wdata": 12, "wstrb": 12, "wvalid": 12, "wreadi": 12, "bresp": 12, "bvalid": 12, "breadi": 12, "extern": 12, "renodeag": 12, "txd": 12, "rxd": 12, "prescal": 12, "repositori": [12, 15, 18, 19], "govern": 13, "foundat": 13, "subproject": 13, "offici": 13, "point": 13, "remov": [13, 19], "attempt": 13, "requir": [13, 20, 21], "zephyr_toolchain_vari": 13, "cross": 13, "cross_compil": [13, 19], "riscv64": [13, 19], "elf": [13, 19], "And": 13, "cd": 13, "homepath": 13, "zephyrproject": 13, "env": 13, "cmd": [13, 18], "west": 13, "auto": 13, "litex_vexriscv": 13, "sampl": 13, "subsi": 13, "shell_modul": 13, "replac": 13, "precomipl": 13, "gdb": [13, 19], "newer": [14, 17], "gnu": [14, 18], "plugdev": 14, "99": 14, "subsystem": 14, "attr": 14, "idvendor": 14, "1209": 14, "idproduct": 14, "5bf0": 14, "0664": 14, "reload": 14, "right": 14, "green": 14, "arrow": 14, "choos": 14, "winusb": 14, "upgrad": 14, "updat": [14, 17], "attend": 15, "git": [15, 18, 19], "master": [15, 19], "zip": 15, "tar": 15, "gz": 15, "udev": [16, 17], "compet": 16, "identifi": 16, "string": 16, "bash": 16, "front": 16, "dark": 16, "blue": [16, 20], "cyan": 16, "light": 16, "bootload": [16, 17], "vx": 16, "origin": 16, "cut": 16, "corner": 16, "easier": 16, "manufactur": 16, "tim": 16, "36c3": 16, "probabl": 16, "white": 16, "silkscreen": 16, "crowd": 16, "suppli": 16, "silver": 16, "crystal": 16, "oscil": 16, "tallest": 16, "schemat": 16, "pdf": 16, "35c3": 16, "cccamp19": 16, "hackadai": 16, "supercon": 16, "2019": 16, "summit": 16, "crowdsuppli": 16, "mouser": 16, "bui": 16, "life": 16, "evt": 16, "ship": [16, 19], "earli": 16, "backer": 16, "fund": 16, "campaign": 16, "credit": 16, "card": 16, "evt3": 16, "across": 16, "evt2": 16, "evt1": 16, "older": 17, "zadig": 17, "disk": 18, "static": 18, "raspberri": 18, "pi": 18, "somewher": 18, "powershel": 18, "ex": 18, "ghdl": 18, "arbitrari": 18, "ghdl_prefix": 18, "confirm": 18, "suit": 18, "copyright": 18, "2012": 18, "2018": 18, "clifford": 18, "wolf": 18, "distribut": 18, "fee": 18, "herebi": 18, "notic": [18, 19], "THE": 18, "AS": 18, "author": 18, "disclaim": 18, "warranti": 18, "WITH": 18, "regard": 18, "TO": 18, "impli": 18, "OF": 18, "merchant": 18, "IN": 18, "NO": 18, "event": 18, "shall": 18, "BE": 18, "liabl": 18, "FOR": 18, "indirect": 18, "OR": 18, "consequenti": 18, "whatsoev": 18, "loss": 18, "profit": 18, "action": 18, "contract": 18, "neglig": 18, "tortiou": 18, "aris": 18, "78b30bbb1102047585d1a2eac89b1c7f5ca7344": 18, "sha1": 18, "41d9173": 18, "gcc": 18, "12ubuntu1": 18, "04": 18, "fpic": 18, "exit": 18, "quit": 18, "readm": [18, 19], "readi": 18, "imag": [18, 19], "eda": 18, "One": 18, "io": 18, "strategi": 18, "fine": 18, "grain": 18, "host": [18, 19], "subdir": 18, "willing": 18, "care": 18, "ghdl_plugin_modul": 18, "container_engin": 18, "engin": 18, "docker": 18, "podman": 18, "unset": 18, "agnost": 18, "fact": 18, "mk": 18, "customis": 18, "ci": 18, "yml": 18, "32": 19, "initi": 19, "rom": 19, "offset": 19, "0x20040000": 19, "0xe0000000": 19, "packet": 19, "pc": 19, "recal": 19, "definit": 19, "0xe0007000l": 19, "0xe0007004l": 19, "0xe0007008l": 19, "0xe0007028l": 19, "got": 19, "thought": 19, "write_raw": 19, "csr_rgb_dat_addr": 19, "csr_rgb_addr_addr": 19, "maximum": 19, "plai": 19, "reset": 19, "csr_reboot_ctrl": 19, "0xe0006000l": 19, "0xac": 19, "random": 19, "aren": 19, "crash": 19, "usberror": 19, "pipe": 19, "went": 19, "talk": 19, "rate": 19, "Of": 19, "cours": 19, "congratul": 19, "increas": 19, "solid": 19, "0xe0006000": 19, "next": 19, "patch": 19, "46": 19, "int": 19, "usb_init": 19, "rgb_init": 19, "usb_connect": 19, "rgb_write": 19, "100000": 19, "64000": 19, "leddbr": 19, "color_wheel": 19, "250": 19, "hz": 19, "peek": 19, "poke": 19, "halt": 19, "attach": 19, "debugg": 19, "bt": 19, "backtrac": 19, "chanc": 19, "land": 19, "msleep": 19, "0x2004014c": 19, "csr_readl": 19, "addr": 19, "3758106664": 19, "timer0_value_read": 19, "242": 19, "0x200401dc": 19, "80": 19, "41": 19, "0x20040074": 19, "45": 19, "insert": 19, "breakpoint": 19, "continu": 19, "mon": 19, "altern": 19, "http": 19, "rustup": 19, "target": 19, "cargo": 19, "manag": 19, "subfold": 19, "riscv32i": 19, "none": 19, "sh": 19, "folder": 19, "abl": 19, "acc": 19, "anymor": 19, "tinyusb": 19, "mass": 19, "com": 19, "hathach": 19, "subrepositori": 19, "cdc_msc": 19, "_build": 19, "sure": [20, 21], "match": [20, 21], "short": 20, "contact": 20, "stick": 20, "sb_ice40_compon": 21, "icecube2": 21}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"background": 0, "about": 0, "fpga": [0, 5], "turn": 0, "code": [0, 12, 19], "gate": 0, "bitstream": 0, "load": 0, "devic": 0, "ice40up5k": 0, "fomu": [0, 1, 4, 7, 8, 10, 16, 18, 19, 20, 21], "bootload": 1, "updat": 1, "hardwar": [2, 16], "descript": 2, "languag": 2, "gener": 2, "get": [3, 11], "help": 3, "irc": 3, "chat": 3, "channel": 3, "mail": 3, "list": 3, "icestudio": 4, "nightli": 4, "hello": [4, 6, 7, 20, 21], "world": [4, 6, 7, 20, 21], "blink": [4, 6, 7, 20, 21], "led": [4, 6, 7, 19, 20, 21], "navig": 4, "board": 4, "rule": [4, 14], "tomu": 5, "workshop": 5, "migen": 6, "litex": [6, 9, 11, 13], "wishbon": [6, 10], "bu": 6, "basic": 6, "extens": [6, 8], "mix": 7, "hdl": 7, "python": 8, "memori": 8, "map": 8, "regist": 8, "rgb": 8, "driver": [8, 14], "work": 9, "co": [9, 12], "simul": [9, 12], "renod": [9, 10, 11, 12, 13], "bridg": 10, "between": 10, "set": [10, 14], "up": [10, 14], "server": 10, "connect": 10, "from": 10, "try": 11, "out": 11, "quickli": 11, "precompil": 11, "demo": 11, "us": [12, 19], "veril": 12, "integr": 12, "run": 13, "your": 13, "own": 13, "zephyr": 13, "binari": 13, "vexriscv": 13, "build": 13, "applic": 13, "app": 13, "debug": [13, 19], "requir": [14, 15, 16, 17, 18], "setup": 14, "udev": 14, "step": 14, "instal": 14, "zadig": 14, "file": 15, "which": 16, "do": 16, "i": 16, "have": 16, "softwar": 18, "toolchain": 18, "contain": 18, "cpu": 19, "interact": 19, "directli": 19, "compil": 19, "risc": 19, "v": 19, "rust": 19, "further": 19, "experi": 19, "verilog": 20, "read": 20, "input": 20, "vhdl": 21}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Background": [[0, "background"]], "About FPGAs": [[0, "about-fpgas"]], "Turning code into gates": [[0, "turning-code-into-gates"]], "Turning gates into a bitstream": [[0, "turning-gates-into-a-bitstream"]], "Loading a bitstream into a device": [[0, "loading-a-bitstream-into-a-device"]], "About the ICE40UP5K": [[0, "about-the-ice40up5k"]], "About Fomu": [[0, "about-fomu"]], "Bootloader": [[1, "bootloader"]], "Updating the Fomu Bootloader": [[1, "updating-the-fomu-bootloader"]], "Hardware Description Languages": [[2, "hardware-description-languages"]], "Languages and generators": [[2, "languages-and-generators"]], "Getting Help": [[3, "getting-help"]], "IRC Chat Channel": [[3, "irc-chat-channel"]], "Mailing Lists": [[3, "mailing-lists"]], "Fomu on IceStudio Nightly": [[4, "fomu-on-icestudio-nightly"]], "\u201cHello world!\u201d - Blink a LED": [[4, "hello-world-blink-a-led"], [6, "hello-world-blink-a-led"], [7, "hello-world-blink-a-led"], [20, "hello-world-blink-a-led"], [21, "hello-world-blink-a-led"]], "Navigation": [[4, "navigation"]], "Board rules": [[4, "board-rules"]], "FPGA Tomu Workshop": [[5, "fpga-tomu-workshop"]], "Migen and LiteX": [[6, "migen-and-litex"]], "Wishbone Bus Basics": [[6, "wishbone-bus-basics"]], "Wishbone Bus Extension": [[6, "wishbone-bus-extension"]], "Mixed HDL on Fomu": [[7, "mixed-hdl-on-fomu"]], "Python on Fomu": [[8, "python-on-fomu"]], "Fomu Python Extensions": [[8, "fomu-python-extensions"]], "Memory-mapped Registers": [[8, "memory-mapped-registers"]], "Memory-mapped RGB driver": [[8, "memory-mapped-rgb-driver"]], "Working with LiteX and (co-)simulation with Renode": [[9, "working-with-litex-and-co-simulation-with-renode"]], "Wishbone bridge between Renode and Fomu": [[10, "wishbone-bridge-between-renode-and-fomu"]], "Setting up the server": [[10, "setting-up-the-server"]], "Connecting from Renode": [[10, "connecting-from-renode"]], "Getting Renode": [[11, "getting-renode"]], "Try out Renode quickly with precompiled LiteX demos": [[11, "try-out-renode-quickly-with-precompiled-litex-demos"]], "Renode Co-simulation using Verilator": [[12, "renode-co-simulation-using-verilator"]], "Integration with verilated code": [[12, "integration-with-verilated-code"]], "Running your own Zephyr binary on LiteX/VexRiscv in Renode": [[13, "running-your-own-zephyr-binary-on-litex-vexriscv-in-renode"]], "Building a Zephyr application": [[13, "building-a-zephyr-application"]], "Run the app in Renode": [[13, "run-the-app-in-renode"]], "Debugging the app in Renode": [[13, "debugging-the-app-in-renode"]], "Required Drivers": [[14, "required-drivers"]], "Setup udev rules": [[14, "setup-udev-rules"]], "Steps to set up udev rule": [[14, "steps-to-set-up-udev-rule"]], "Installing Zadig Drivers": [[14, "installing-zadig-drivers"]], "Required Files": [[15, "required-files"]], "Required Hardware": [[16, "required-hardware"]], "Which Fomu do I have?": [[16, "which-fomu-do-i-have"]], "Requirements": [[17, "requirements"]], "Required Software": [[18, "required-software"]], "Fomu Toolchain": [[18, "fomu-toolchain"]], "Containers": [[18, "containers"]], "Fomu as a CPU": [[19, "fomu-as-a-cpu"]], "Interacting with the LED Directly": [[19, "interacting-with-the-led-directly"]], "Compiling RISC-V Code": [[19, "compiling-risc-v-code"]], "Debugging RISC-V Code": [[19, "debugging-risc-v-code"]], "Using Rust": [[19, "using-rust"]], "Further RISC-V experiments": [[19, "further-risc-v-experiments"]], "Verilog on Fomu": [[20, "verilog-on-fomu"]], "Reading Input": [[20, "reading-input"]], "VHDL on Fomu": [[21, "vhdl-on-fomu"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/verilog.html b/verilog.html new file mode 100644 index 0000000..70ef5f8 --- /dev/null +++ b/verilog.html @@ -0,0 +1,336 @@ + + + + + + + + + + + + Verilog on Fomu — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

Verilog on Fomu

+ +
+

Reading Input

+

There is another small example in hdl/verilog/blink-expanded which shows how to read +out some given pins. +Build and flash it like described above and see if you can enable the blue and red LED by shorting pins 1+2 or 3+4 on +your Fomu (the pins are the exposed contacts sticking out of the USB port).

+
+
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Hardware Description Languages
+
+ + + arrow_forward +
+ Next +
VHDL on Fomu
+
+ +
+
+
+ +
+
    + + + +
  • + a +
    • +
+
+
+ +
+
© Copyright 2019, Tomu Project Authors.
+
Generated by Sphinx + 5.3.0 using sphinx_symbiflow_theme.
+
+
+
+
+ + \ No newline at end of file diff --git a/vhdl.html b/vhdl.html new file mode 100644 index 0000000..d888e83 --- /dev/null +++ b/vhdl.html @@ -0,0 +1,335 @@ + + + + + + + + + + + + VHDL on Fomu — FPGA Tomu (Fomu) Workshop documentation + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+
+
+ +
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+
+
+ + + + + + + + +
+ Table Of Contents + + + + + +
+ +
+ +
+
+ +
+

VHDL on Fomu

+
+

Hint

+

Component declarations for instantiating hard cores (such as the ones in +hdl/sb_ice40_components.vhd) are found in the installation of +iCEcube2.

+
+ +
+ + +
+
+
+
+

+ Table Of Contents +

+ + +
+
+
+ +
+
+ + arrow_back +
+ Previous +
Verilog on Fomu
+
+ + + arrow_forward +
+ Next +
Mixed HDL on Fomu
+
+ +
+ +
+
+ + \ No newline at end of file