pynq.board.rgbled — Python productivity for Zynq (Pynq) v1.0

# Source code for pynq.board.rgbled

    #   Copyright (c) 2016, Xilinx, Inc.
    #   All rights reserved.
    #
    #   Redistribution and use in source and binary forms, with or without
    #   modification, are permitted provided that the following conditions are met:
    #
    #   1.  Redistributions of source code must retain the above copyright notice,
    #       this list of conditions and the following disclaimer.
    #
    #   2.  Redistributions in binary form must reproduce the above copyright
    #       notice, this list of conditions and the following disclaimer in the
    #       documentation and/or other materials provided with the distribution.
    #
    #   3.  Neither the name of the copyright holder nor the names of its
    #       contributors may be used to endorse or promote products derived from
    #       this software without specific prior written permission.
    #
    #   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    #   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
    #   THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    #   PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
    #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    #   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    #   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
    #   OR BUSINESS INTERRUPTION). HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    #   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
    #   OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
    #   ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    __author__ = "Graham Schelle"
    __copyright__ = "Copyright 2016, Xilinx"
    __email__ = "pynq_support@xilinx.com"

    from pynq import MMIO
    from pynq import PL

    RGBLEDS_XGPIO_OFFSET = 0
    RGBLEDS_START_INDEX  = 4

    """ Reference Color Values for RGB LED """
    RGB_CLEAR = 0
    RGB_BLUE = 1
    RGB_GREEN = 2
    RGB_CYAN = 3
    RGB_RED = 4
    RGB_MAGENTA = 5
    RGB_YELLOW = 6
    RGB_WHITE = 7

    class RGBLED(object):
        """This class controls the onboard RGB LEDs.

        Attributes
        ----------
        index : int
            The index of the RGB LED, from 4 (LD4) to 5 (LD5).
        _mmio : MMIO
            Shared memory map for the RGBLED GPIO controller.
        _rgbleds_val : int
            Global value of the RGBLED GPIO pins.

        """
        _mmio = None
        _rgbleds_val = 0

        def __init__(self, index):
            """Create a new RGB LED object.

            Parameters
            ----------
            index : int
                Index of the RGBLED, from 4 (LD4) to 5 (LD5).

            """
            if not index in [4,5]:
                raise Value("Index for onboard RGBLEDs should be 4 - 5.")

            self.index = index
            if RGBLED._mmio is None:
                base_addr = int(PL.ip_dict["SEG_rgbled_gpio_Reg"][0],16)
                RGBLED._mmio = MMIO(base_addr,16)

        def on(self, color):
            """Turn on a single RGB LED with a color value (see color constants).

            Parameters
            ----------
            color : int
               Color of RGB specified by a 3-bit RGB integer value.

            Returns
            -------
            None

            """
            if not color in range(8):
                raise ValueError("RGB values should be between 0 and 7.")

            rgb_mask = 0x7 << ((self.index-RGBLEDS_START_INDEX)*3)
            new_val = (RGBLED._rgbleds_val & ~rgb_mask) | \
                      (color << ((self.index-RGBLEDS_START_INDEX)*3))
            self._set_rgbleds_value(new_val)

        def off(self):
            """Turn off a single RGBLED.

            Parameters
            ----------
            None

            Returns
            -------
            None

            """
            rgb_mask = 0x7 << ((self.index-RGBLEDS_START_INDEX)*3)
            new_val = RGBLED._rgbleds_val & ~rgb_mask
            self._set_rgbleds_value(new_val)

        def write(self, color):
            """Set the RGBLED state according to the input value.

            Parameters
            ----------
            color : int
                Color of RGB specified by a 3-bit RGB integer value.

            Returns
            -------
            None

            """
            self.on(color)

        def read(self):
            """Retrieve the RGBLED state.

            Returns
            -------
            int
                The color value stored in the RGBLED.

            """
            return (RGBLED._rgbleds_val >> ((self.index-RGBLEDS_START_INDEX)*3)) & 0x7

        def _set_rgbleds_value(self, value):
            """Set the state of all RGBLEDs.

            Note
            ----
            This function should not be used directly. User should call
            `on()`, `off()`, instead.

            Parameters
            ----------
            value : int
                The value of all the RGBLEDs encoded in a single variable.

            """
            RGBLED._rgbleds_val = value
            RGBLED._mmio.write(RGBLEDS_XGPIO_OFFSET, value)