Gamma Corrector IP Core User Guide March 2015 IPUG64_1.3 Table of Contents Chapter 1. Introduction .......................................................................................................................... 4 Quick Facts ........................................................................................................................................................... 4 Features ................................................................................................................................................................ 5 Chapter 2. Functional Description ........................................................................................................ 6 Block Diagram....................................................................................................................................................... 6 Gamma Correction Equation................................................................................................................................. 6 Filling the Gamma LUT ......................................................................................................................................... 7 Multi-Color Plane/Channel Mapping ..................................................................................................................... 7 Dynamically Loadable Gamma LUTs.................................................................................................................... 8 Handshake I/O Ports............................................................................................................................................. 8 Signal Descriptions ............................................................................................................................................... 8 Interfacing with the Gamma Corrector .................................................................................................................. 9 Parallel and Sequential Architectures .......................................................................................................... 9 Valid Output ................................................................................................................................................. 9 Timing Specifications .......................................................................................................................................... 10 Parallel Architecture Timing ....................................................................................................................... 10 Sequential Architecture Timing .................................................................................................................. 11 Dynamically Loadable Gamma LUT Timing............................................................................................... 12 Chapter 3. Parameter Settings ............................................................................................................ 14 Configuration Tab................................................................................................................................................ 14 Implementation Tab ............................................................................................................................................ 15 Configuring the Gamma Corrector IP.................................................................................................................. 16 Chapter 4. IP Core Generation............................................................................................................. 17 Licensing the IP Core.......................................................................................................................................... 17 Getting Started .................................................................................................................................................... 17 Configuring Gamma Corrector Core in IPexpress ..................................................................................... 17 Configuring Gamma Corrector Core in Clarity Designer............................................................................ 18 IPexpress-Created Files and Top-Level Directory Structure...................................................................... 21 Clarity Designer-Created Files and IP Top Level Directory Structure........................................................ 22 Instantiating the Core ................................................................................................................................. 23 Running Functional Simulation .................................................................................................................. 23 Synthesizing and Implementing the Core in a Top-Level Design .............................................................. 24 Hardware Evaluation........................................................................................................................................... 24 Enabling Hardware Evaluation................................................................................................................... 24 Updating/Regenerating the IP Core .................................................................................................................... 25 Regenerating an IP Core in IPexpress....................................................................................................... 25 Regenerating/Recreating the IP Core in Clarity Designer................................................................................... 26 Regenerating an IP Core in Clarity Designer Tool ..................................................................................... 26 Recreating an IP Core in Clarity Designer Tool ......................................................................................... 26 Chapter 5. Support Resources ............................................................................................................ 27 Lattice Technical Support.................................................................................................................................... 27 Lattice Technical Support.................................................................................................................................... 27 E-mail Support ........................................................................................................................................... 27 Local Support ............................................................................................................................................. 27 Internet ....................................................................................................................................................... 27 References.......................................................................................................................................................... 27 Revision History .................................................................................................................................................. 27 Appendix A. Resource Utilization ....................................................................................................... 28 ECP5 Devices ..................................................................................................................................................... 29 (c) 2015 Lattice Semiconductor Corp. All Lattice trademarks, registered trademarks, patents, and disclaimers are as listed at www.latticesemi.com/legal. All other brand or product names are trademarks or registered trademarks of their respective holders. The specifications and information herein are subject to change without notice. IPUG64_01.3, March 2015 2 Gamma Corrector IP Core User Guide Table of Contents Ordering Part Number................................................................................................................................ 29 LatticeECP3 Devices .......................................................................................................................................... 29 Ordering Part Number................................................................................................................................ 29 LatticeXP2 Devices ............................................................................................................................................. 29 Ordering Part Number................................................................................................................................ 29 IPUG64_01.3, March 2015 3 Gamma Corrector IP Core User Guide Chapter 1: Introduction Gamma correction is a type of pre-distortion correction made to images or video frames to offset the non-linear behavior of display systems, such as cathode ray tube (CRT) displays. A characteristic of CRT displays is that the intensity they generate is not a linear function of the input voltage. Instead, the intensity is proportional to a power of the signal amplitude, also referred to as gamma. Gamma is usually greater than 1 and therefore the displays have a lower gain at low intensities and progressively larger gain at higher intensities. The Gamma Corrector IP core multiplies the input signal with the inverse of the display transfer function which results in a linear intensity response with respect to the original input signal. Several gamma correction methods and values are used in television and display systems. Plasma, LCOS (Liquid Crystal on Silicon) and DLP (Digital Light Processing) displays have transfer characteristics that are different from that of CRT displays. Sometimes the display itself can have linear characteristics, but a gamma transformation (usually called degamma) may be required because of an earlier gamma correction made to the incoming signal. The Gamma Corrector IP core is a widely parameterizable, multi-color plane gamma correction system. It can support almost any custom gamma correction requirement. Quick Facts Table 1-1 gives quick facts about the Gamma Corrector IP core. Table 1-1. Gamma Corrector IP Core Quick Facts Gamma Corrector IP Core Sequential Architecture 3 Color Planes Same Color Planes FPGA Families Supported Core Requirements Minimum Device Required LUTs ECP5 Resource Utilization LatticeECP3 LatticeXP2 EBRs Sequential Architecture 3 Color Planes Different Color Planes ECP5TM, LatticeECP3TM, LatticeXP2TM LFE5U-25F LFE5UM-25F LAE5UM-25F LFE3-17EA LFXP2-5E LFE5U-25F LFE5UM-25F LAE5UM-25F LFE3-17EA LFXP2-5E LFE5U-25F LFE5UM-25F LAE5UM-25F LFE3-17EA LFXP2-5E 27 36 24 3 9 3 113 265 104 Slices 57 133 52 LUTs 33 39 30 Registers EBRs 3 9 3 113 265 104 Slices 57 133 52 LUTs 27 36 24 Registers EBRs 3 9 3 Registers 113 265 104 Slices 57 133 52 Lattice Diamond(R) 3.4 Lattice Implementation Design Tool Support Parallel Architecture 3 Color Planes Same Color Planes Synthesis Synopsys(R) Synplify ProTM for Lattice J-2014.09L Lattice Synthesis Engine Simulation Aldec(R) Active-HDLTM 9.3 SP2 Lattice Edition II Mentor Graphics(R) ModelSimTM SE 6.6 IPUG64_01.3, March 2015 4 Gamma Corrector IP Core User Guide Introduction Features * Configurable number of color planes: 1 to 3 * Configurable number of bits per color plane: 4 to 12 * Option to specify gamma correction characteristics as an equation using a gamma value or by the actual mapping values of the look-up table * Gamma correction look-up table can be run-time programmable * Optimized gamma look-up table memory when same gamma correction is used for multiple color planes * Gamma correction enable/disable control * Option for sequential or parallel architecture for area or throughput trade-off * Registered input option for input set-up time improvement IPUG64_01.3, March 2015 5 Gamma Corrector IP Core User Guide Chapter 2: Functional Description Block Diagram Figure 2-1 shows the interface diagram for the Gamma Corrector IP core. The diagram shows all of the available ports for the IP core. Note that not all the I/O ports are available for a chosen configuration. Figure 2-1. Top-level Interface Diagram for the Gamma Corrector IP Core clk ce outvalid rstn sr gcvalid inpvalid gcen dout0 din0 din1 din2 cpsel lut0wren lut0val lut1wren lut1val lut2wren lut2val Gamma Corrector dout1 dout2 cpout optional programmable pin The Gamma Corrector is essentially a look-up-table (referred to as gamma LUT in this document) that maps each input value to a corresponding output value having the same width. The Gamma Corrector IP core supports simultaneous gamma correction up to three color planes, which is useful to the applications that require simultaneous gamma correction on all color components, for example, R, G and B (red, green and blue). Gamma correction for multiple color planes can also be used for gamma correction of multiple monochrome channels either in parallel or sequentially. The core supports an ability to dynamically load the gamma LUT values into the gamma corrector. The core also provides an option for sequential gamma conversion to reduce memory utilization for each color plane. Gamma Correction Equation Gamma correction is a non-linear exponent mapping applied to the normalized value of the input to result in a normalized corrected output. Gamma correction is defined by: (1) 1 ON = IN where ON is the normalized output and IN is the normalized input, both normalized to the range [0,1] and is the gamma for the display that is being corrected. The actual pixel mapping depends on the bit width of the pixel component. For a pixel width of b bits, we have: 1 O= IPUG64_01.3, March 2015 IN 2b-1 6 (2b-1) (2) Gamma Corrector IP Core User Guide Functional Description Here O is the actual output pixel value represented as a b-bit binary number. The original response of a CRT with gamma = 2.2, gamma correction and the response of the CRT display for the gamma corrected input are shown in Figure 2-2. Figure 2-2. Original, Correction and After Correction Response Curves Filling the Gamma LUT Based on the above equation, the size of the gamma LUT is 2b bits deep and b bits wide. In most cases, the gamma LUT is pre-filled with the gamma correction value for each pixel value from 0 to 2b-1. The gamma correction function can be specified by the gamma value used in Equation (2) or the actual gamma mapping values for each input pixel value. This IP supports reloading of the gamma LUT through input ports. It takes as many system clock cycles as the number of locations in the gamma LUT to program it completely. While the LUTs are being programmed, gamma correction cannot take place. The IP core can have one or more gamma LUTs when used for mapping different color plane data or channels. If there are multiple gamma LUTs in the IP, for example, one for each of the three color planes, a selection input (cpsel) determines which color plane or channel is being processed at any time. The Gamma Corrector IP optimizes the number of physical gamma LUTs required depending on the value of the gamma for each color plane and the number of simultaneous I/Os selected by the user. Multi-Color Plane/Channel Mapping Gamma correction of multiple color planes or channels can be done either sequentially or in parallel. In sequential correction, only one color component datum is mapped during a clock cycle. For example, if there are three color planes, the Gamma Corrector requires three clocks to process a color pixel. The input cpsel is used to identify which color plane LUT needs to be used for the current input. The same cpsel input can be used to time multiplex multiple channels (multiple displays) having different gamma correction requirements. In parallel correction, gamma correction of more than one color plane or channel is done simultaneously. IPUG64_01.3, March 2015 7 Gamma Corrector IP Core User Guide Functional Description Dynamically Loadable Gamma LUTs The gamma LUTs can be dynamically loaded or re-programmed after the IP is generated. During LUT programming, each of the possible input values is applied at the input port dinx and the corresponding correction value at the input lutxval while keeping the corresponding LUT write enable (lutxwren) signal high (x in the port names stands for 0, 1 or 2). If the core is configured for the sequential mode, each of the LUTs corresponding to the color planes or channels is programmed sequentially. The value at the input port cpsel is used to identify the LUT that is programmed. Handshake I/O Ports The input gcen is used to enable gamma correction. If this signal is low, the gamma correction is bypassed and the input value appears at the output after the usual latency for that configuration. The vector port cpsel identifies the color plane or channel number that is being processed or programmed. The output cpout provides the color plane or channel number information for the current output(s) appearing at doutx (x stands for 0, 1 or 2) port(s). Signal Descriptions The I/O port definitions for the Gamma Corrector IP core are given in Table 2-1. Table 2-1. I/O Interface Descriptions Port Bits I/O Description All Configurations clk 1 I System clock (reference clock for input and output data). rstn 1 I System wide asynchronous active-low reset signal. inpvalid 1 I Input data valid. Indicates valid data is present on din0 (also on din1 and din2 when present). din0 4 to 12 I Input Data. When the sequential architecture is selected, this port is used to give input data for all the color planes in sequence. When the parallel architecture is selected, this port is used to give input data for the first color plane. dout0 4 to 12 O Output Data. When the sequential architecture is selected, this port is used to give the output data for all the color planes in sequence. When the parallel architecture is selected, this port is used to give output data for the first color plane. 1 O Output data valid. Indicates valid data is present on dout0 (also on dout1 and dout2 when present). This valid data may correspond to the gamma corrected output or the bypassed input data, depending on the state of the gcvalid signal. outvalid When `Add Bypass Function' Option is Selected gcen 1 I Gamma correction enable. This signal is valid only when inpvalid is asserted high. If gcen is high, gamma correction is performed for that input. Otherwise, no gamma correction is performed. gcvalid 1 O Gamma corrected output. This signal is valid only when outvalid is high. If gcvalid is high, the output is a gamma corrected value, otherwise the output is a bypassed value, same as input. The output gcvalid is a shifted version of the input signal gcen, the shift being equal to the output latency. When Parallel Architecture is Selected and Number of Color Planes is More Than 1 din1 4 to 12 I Input data for the second color plane. dout1 4 to 12 O Output data for the second color plane. When Parallel Architecture is Selected and Number of Color Planes is More Than 2 din2 4 to 12 I Input data for the third color plane. dout2 4 to 12 O Output data for the third color plane. When First Color Plane Gamma Function is Selected as Programmable lut0val 4 to 12 IPUG64_01.3, March 2015 I Gamma value is programmed through the lut0val port when lut0wren is asserted high. The value from the lut0val port is written to the gamma LUT at the address provided at the din0 input port. 8 Gamma Corrector IP Core User Guide Functional Description Port lut0wren Bits I/O 1 I Description Write enable for writing the gamma value for the first color plane. When Second Color Plane Gamma Function is Selected as Programmable, Parallel Architecture is Selected and Number of Color Planes is More Than 1 lut1val lut1wren 4 to 12 I Gamma value is programmed through the lut1val port when lut1wren is asserted high. The value from the lut1val port is written to the gamma LUT at the address provided at the din1 input port. 1 I Write enable for writing the gamma value for the second color plane. When Third Color Plane Gamma Function is Selected as Programmable, Parallel Architecture is Selected and Number of Color Planes is More Than 2 lut2val lut2wren 4 to 12 I Gamma value is programmed through the lut2val port when lut2wren is asserted high. The value from the lut2val port is written to the gamma LUT at the address provided at the din2 input port. 1 I Write enable for writing the gamma value for the second color plane. When sequential architecture is selected cpsel 1 to 2 I Input color plane select. The inputs at din0, lut0val and lut0wren apply to the color plane provided at cpsel. cpout 1 to 2 O Output color plane select. The output at dout0 corresponds to the color plane provided at cpout. ce 1 I Clock Enable. While this is low, the core will ignore all other synchronous inputs and maintain its current state. This optional signal should be selected only when required as it leads to increased resource utilization. sr 1 I Synchronous Reset. This signal must be asserted for at least one clock period duration in order to re-initialize the core. After synchronous reset, all the internal registers are cleared and the outvalid goes low. This optional signal should be selected only when required as it leads to increased resource utilization. Optional I/Os Interfacing with the Gamma Corrector Parallel and Sequential Architectures The Gamma Corrector IP offers the choice of two different architectures: parallel and sequential. In the parallel architecture, all the color plane data are applied at the same time. The output data for all the color planes are also available at the same time after a latency of a few clock cycles. In the sequential architecture, the input data for the color planes is applied in sequence, one after the other, using the same input port din0. The output data for the color planes is given out sequentially using the same output port dout0 after a latency of a few clock cycles. When sequential architecture is selected, the input port din0 and output port dout0 are shared between all the color planes. If the data widths are not the same for all color planes, then the highest data width must correspond to the first color plane. When the data width is less than the input port (din0 and lut0val) size, the data must be left aligned and the unused LSBs must be driven with zeros. Similarly, the output data is left aligned with unused LSBs driven to zero, when the data width is less than the output port (dout0) size. The color plane or channel number provided on cpsel can be in order, allowing the processing of multi-rate channels. Valid Output The data output of the Gamma Corrector IP is valid after the output latency for the selected configuration and is indicated by outvalid going high. Output latency for Gamma Corrector IP, defined as the number of clock cycles between the sampling of the input data and the availability of the gamma corrected data at the output port, is from 4 to 6 clock cycles depending on the parameters selected. IPUG64_01.3, March 2015 9 Gamma Corrector IP Core User Guide Functional Description Timing Specifications Parallel Architecture Timing Figure 2-3 shows the timing diagram for the parallel architecture. The input data for all the color planes are applied simultaneously on the input ports din0, din1 and din2. The signal inpvalid is asserted to indicate a valid input data present on the input ports. After a latency of a few cycles, the output data for all the color planes appear on the output ports dout0, dout1 and dout2. The signal outvalid is asserted to indicate a valid output data present on the output ports. If signal gcen is asserted then the data from the input ports is to be gamma corrected and given at the output. A gamma corrected output at the output ports is indicated by a high gcvalid signal. If the signal gcen is not asserted, the data from the input ports is passed on directly to the output ports. This is indicated by a low gcvalid signal at the output. Figure 2-3. Parallel Architecture clk rstn gcen inpvalid din0 a(0) a(1) a(2) a(3) a(4) a(5) a(6) a(7) a(8) a(9) a(10) a(11) a(12) a(13) a(14) a(15) a(16) a(17) din1 b(0) b(1) b(2) b(3) b(4) b(5) b(6) b(7) b(8) b(9) b(10) b(11) b(12) b(13) b(14) b(15) b(16) b(17) din2 c(0) c(1) c(2) c(3) c(4) c(5) c(6) c(7) c(8) c(9) c(10) c(11) c(12) c(13) c(14) c(15) c(16) c(17) gcvalid outvalid dout0 x(0) x(1) x(2) x(3) a(4) x(5) x(6) x(7) x(8) x(9) x(10) x(11) x(12) x(13) dout1 y(0) y(1) y(2) y(3) b(4) y(5) y(6) y(7) y(8) y(9) y(10) y(11) y(12) y(13) z(0) z(1) z(2) z(3) c(4) z(5) z(6) z(7) z(8) z(9) z(10) z(11) z(12) z(13) dout2 IPUG64_01.3, March 2015 Output latency 10 Gamma Corrector IP Core User Guide Functional Description Sequential Architecture Timing Figure 2-4 shows the input and output signal timing for the sequential architecture. The input data for the three color planes are applied in sequence at the input port din0. The signal inpvalid is asserted to indicate a valid data on din0. After a latency of a few cycles the output data for the first color plane appears on the output port dout0. In the following two cycles, the second and third color plane data appear on dout0. The signal outvalid is asserted to indicate a valid data on dout0. Figure 2-4. Sequential Architecture clk rstn inpvalid cpsel din0 0 1 2 0 1 2 0 1 2 0 1 2 0 1 2 0 1 2 a(0) b(0) c(0) a(1) b(1) c(1) a(2) b(2) c(2) a(3) b(3) c(3) a(4) b(4) c(4) a(5) b(5) c(5) outvalid cpout 0 1 2 0 1 2 0 1 2 0 1 2 0 1 dout0 x(0) y(0) z(0) x(1) y(1) z(1) x(2) y(2) z(2) x(3) y(3) z(3) x(4) y(4) Output latency IPUG64_01.3, March 2015 11 Gamma Corrector IP Core User Guide Functional Description Dynamically Loadable Gamma LUT Timing Figure 2-5. Example of Dynamic Gamma Value Programming, Three Color Planes, Sequential Mode clk rstn inpvalid St0 lut0wren cpsel din0 cp1 cp2 cp3 cp1 cp2 cp3 cp1 cp2 cp3 cp1 cp2 cp3 cp1 cp2 cp3 cp1 cp2 cp3 address1 address2 address3 address4 address5 address6 value1 value2 value3 value4 value5 value6 lut0val Figure 2-6. Example of Dynamic Gamma Value Programming, Three Color Planes, Parallel Mode clk rstn gcen inpvalid din0 ad0 ad1 ad2 ad3 ..... a(0) a(1) a(2) a(3) a(4) a(5) a(6) a(7) a(8) a(9) a(10) din1 ad0 ad1 ad2 ad3 ..... b(0) b(1) b(2) b(3) b(4) b(5) b(6) b(7) b(8) b(9) b(10) din2 ad0 ad1 ad2 ad3 ..... c(0) c(1) c(2) c(3) c(4) c(5) c(6) c(7) c(8) c(9) c(10) v0 v1 v2 v3 ..... v0 v1 v2 v3 ..... v0 v1 v2 v3 ..... lut0 wren lut0val lut1 wren lut1val lut2 wren lut2val gcvalid outvalid dout0 dout1 dout2 x(0) x(1) x(2) x(3) a(4) x(5) x(6) y(0) y(1) y(2) y(3) b(4) y(5) y(6) z(0) z(1) z(2) z(3) c(4) z(5) z(6) Output latency IPUG64_01.3, March 2015 12 Gamma Corrector IP Core User Guide Functional Description Figure 2-7. Functionality of Programmable Gamma through Look-Up Table (LUT) Figure 2-8. Functionality of Constant Gamma Value (= 2.2) IPUG64_01.3, March 2015 13 Gamma Corrector IP Core User Guide Chapter 3: Parameter Settings The IPexpressTM or Clarity Designer tool is used to create IP and architectural modules in the Diamond software. Refer to the IP Core Generation section for a description of how to generate the IP. The Gamma Corrector IP core can be customized to suit a specific application by adjusting parameters prior to core generation. Since the values of some parameters affect the size of the resultant core, the maximum value for these parameters may be limited by the size of the target device. Table 3-1 describes the user-configurable parameters available in the Gamma Corrector IP GUI. The GUI tabs for the default configuration are shown in Figure 3-1 and Figure 3-2. Table 3-1. User Configurable Parameters Name Range Default Common Color Plane Options Number of color planes {1,2,3} 3 {Yes, No} Yes {Sequential, Parallel} Sequential {4, 5, 6, 7, 8, 9, 10, 11, 12} 8 {Gamma value, Through LUT file} Gamma value 0.1 to 10.0 2.2 Gamma function through file N/A N/A Programmable gamma LUT {Yes, No} Yes {Yes, No} Yes Make all color planes same Architecture Architecture Individual Color Plane Options Data width Gamma function input method Gamma value Implementation Add bypass function Registered input {Yes, No} Yes {EBR, Distributed, Automatic} Automatic {4,5,6} 6 ce {Yes, No} No sr {Yes, No} No Memory type Output latency Optional Input Ports Configuration Tab The Configuration tab provides settings for common color plane options, architecture and individual color plane options. See Figure 3-1. IPUG64_01.3, March 2015 14 Gamma Corrector IP Core User Guide Parameter Settings Figure 3-1. Configuration Tab of the Gamma Corrector IP Core GUI Number of color planes: Sets the number of color planes for gamma correction. Make all color planes same: Selecting this option will make all the other color plane parameters the same as those of the first color plane. Architecture: Selects between parallel and sequential implementation architectures. Data width: Sets the bit-width for the color plane. Gamma function input method: The method for specifying the gamma function. The function can be specified by the value of the gamma in the gamma correction equation or by the actual gamma mapping values for the all the pixel values in the input range. Gamma value: This gamma value is used to create the gamma LUT using equation (1). This parameter is available when the Gamma function input method is selected as "Gamma value". Gamma function through file: This browse button is enabled when the Gamma function input method is set to "Through LUT file". The gamma LUT values will be read from the text file specified. Programmable gamma LUT: This parameter is used to indicate if the gamma LUT is also programmable through the input port. Implementation Tab The Implementation tab provides settings for implementation, optional input/output ports and output latency options. See Figure 3-2. IPUG64_01.3, March 2015 15 Gamma Corrector IP Core User Guide Parameter Settings Figure 3-2. Implementation Tab of the Gamma Corrector IP Core GUI Add bypass function: Selecting this option will add the dynamic gamma correction bypass functionality. Input port gcen and output port gcvalid are added to the Gamma Corrector IP core. Registered input: The inputs are registered if this option is selected. The core inputs' set-up times will improve by registering the inputs. This option is useful when the input data is provided on the device pins. Memory type: This parameter influences the type of memory used to implement the gamma LUT. If the "EBR" option is selected then the device's EBR (Embedded Block RAM) resources are used for the gamma LUT if the data width is greater than 4. If the "Distributed" option is selected, distributed memory (realized using the FPGA's LUTs) is used for the gamma LUT if data width is less than 9. If the "Automatic" option is selected, the memory resources are automatically selected in an optimal way, typically using distributed memories for data widths less than 7 and block memories for higher data widths. There are exceptions to the above-mentioned split of EBR/distributed memory usage for complex configurations that require optimization of the gamma LUT for multiple color planes. Output latency: This static display shows the output latency for the selected core configuration. Optional input ports: * ce: Optional clock enable input port ce is added to the IP core if this option is checked. * sr: Optional synchronous reset input port sr is added to the IP core if this option is checked. Configuring the Gamma Corrector IP When the gamma function input method is selected as Through LUT file, the gamma values are provided through a data file as decimal numbers. This data file contains the actual mapped gamma values. If the data width is 4 bits, then 16 values for the look up table are provided with the value for address 0 in the first line, the value for address 1 in the second line, and so on. Only the gamma-mapped values and not the addresses, are provided in the data file and the address is assumed to start from 0, running sequentially. The following is an example of the gamma LUT data file for a data width of 4 bits and gamma of 2.2. 0 4 6 7 8 9 10 11 11 12 12 13 14 14 15 15 IPUG64_01.3, March 2015 16 Gamma Corrector IP Core User Guide Chapter 4: IP Core Generation This section provides information on how to generate the Gamma Corrector IP core using the Diamond IPexpress or Clarity Designer tool, and how to include the core in a top-level design. Licensing the IP Core An IP core- and device-specific license is required to enable full, unrestricted use of the Gamma Corrector IP core in a complete, top-level design. Users may download and generate the Gamma Corrector IP core and fully evaluate the core through functional simulation and implementation (synthesis, map, place and route) without an IP license. The Gamma Corrector IP core supports the Lattice IP hardware evaluation capability, which makes it possible to create versions of the IP core which operate in hardware for a limited time (approximately four hours) without requiring an IP license. See the Hardware Evaluation section for further details. However, a license is required to enable timing simulation, to open the design in the Diamond EPIC tool, and to generate bitstreams that do not include the hardware evaluation timeout limitation. Getting Started The Gamma Corrector IP core is available for download and installation from the Lattice IP Server using the IPexpress or Clarity Designer tool. After the IP core has been installed, the IP core will be available in the IPexpress or Clarity Designer GUI dialog box. Configuring Gamma Corrector Core in IPexpress The Gamma Corrector IP core is found under IP > DSP as shown in Figure 4-1. This start-up IPexpress page allows the user to select the IP to be generated, project directory, user-designated module name, design entry type and target device. To generate a specific IP core configuration, the user specifies: * Project Path - Path to the directory where the generated IP files will be located. * File Name - "username" designation given to the generated IP core and corresponding folders and files. * Module Output - Verilog or VHDL. * Device Family - Device family to which IP is to be targeted. Only families that support the particular IP core are listed. * Part Name - Specific targeted part within the selected device family. The Gamma Corrector configuration GUI is accessed by clicking the Customize button, and provides an interface for setting the desired parameters and invoking the IP core generator as shown in Figure 4-4. IPUG64_01.3, March 2015 17 Gamma Corrector IP Core User Guide IP Core Generation Figure 4-1. IPexpress Dialog Box Note: File Name cannot be "gamma_core," as this name has been used in the internal design of the core. If the IPexpress tool is called from within an existing project, Project Path, Module Output, Device Family and Part Name default to the specified project parameters. Refer to the IPexpress tool online help for further information. To create a custom configuration, the user clicks the Customize button in the IPexpress tool dialog box to display the Gamma Corrector IP core configuration GUI, as shown in Figure 4-3. From this dialog box, the user can select the IP parameter options specific to their application. Refer to the Parameter Settings section for more information on the Gamma Corrector IP core parameter settings. Configuring Gamma Corrector Core in Clarity Designer The Gamma Corrector IP core is found under IP > DSP in the Clarity Designer IP Catalog Window as shown in Figure 4-2. Figure 4-2. Clarity Designer Catalog Window IPUG64_01.3, March 2015 18 Gamma Corrector IP Core User Guide IP Core Generation To configure the IP core, double click the Gamma Corrector IP shown in the Catalog tab of the GUI. This step opens the IP Project Dialog box as shown in Figure 4-3. Figure 4-3. Clarity Designer IP Project Dialog Box Enter the following information as described below. * Instance Path - Path to the directory where the generated IP files will be loaded. * Instance Name - "username" designation given to the generated IP core and corresponding folders and files. (Caution: Instance Name cannot be "gamma_core," as this name has been used in the internal design of the core.) * Module Output - Verilog or VHDL. * Device Family - Shows the selected device family. * Part Name - Shows the selected part within the selected device family. To create a custom configuration: 1. Click the Customize button in the IP Project dialog box to display the Gamma Corrector IP core Configuration GUI, as shown in Figure 4-5. 2. Select the IP parameter options specific to their application. Refer to the Parameter Settings section on the Gamma Correction parameter settings. 3. Click Configure then Close to create the IP core with the selected configuration. IPUG64_01.3, March 2015 19 Gamma Corrector IP Core User Guide IP Core Generation Figure 4-4. Configuration GUI IPUG64_01.3, March 2015 20 Gamma Corrector IP Core User Guide IP Core Generation IPexpress-Created Files and Top-Level Directory Structure When the user clicks the Generate button in the IP Configuration dialog box, the IP core and supporting files are generated in the specified "Project Path" directory. The directory structure of the generated files is shown in Figure 4-5. Figure 4-5. Gamma Corrector IP Core Directory Structure Table 4-1 provides a list of key files and directories created by the IPexpress tool and how they are used. The IPexpress tool creates several files that are used throughout the design cycle. The names of most of the created files are customized to the user's module name specified in the IPexpress tool. Table 4-1. File List File Description <username>.lpc This file contains the IPexpress tool options used to recreate or modify the core in the IPexpress tool. <username>.ipx The IPX file holds references to all of the elements of an IP or Module after it is generated from the IPexpress tool (Diamond version only). The file is used to bring in the appropriate files during the design implementation and analysis. It is also used to re-load parameter settings into the IP/Module generation GUI when an IP/Module is being re-generated. <username>.ngo This file provides the synthesized IP core. <username>_bb.v This file provides the synthesis black box for the user's synthesis. <username>_inst.v This file provides an instance template for the Gamma Corrector IP core. <username>_beh.v This file provides the front-end simulation library for the Gamma Corrector IP core. IPUG64_01.3, March 2015 21 Gamma Corrector IP Core User Guide IP Core Generation Table 4-2 provides a list of additional key files that provide IP core generation status information and command line generation capability that are generated in the user's project directory. Table 4-2. Additional Files File Description <username>_generate.tcl This file is created when the GUI Generate button is pushed. This file may be run from command line. <username>_generate.log This is the synthesis and map log file. <username>_gen.log This is the IPexpress IP generation log file. Clarity Designer-Created Files and IP Top Level Directory Structure When the user clicks the Configure button then the Close button in the IP Configuration dialog box, the IP core and supporting files are generated in the specified "Instance Path" directory. An example of the directory structure of the generated files is shown in Figure 4-6. Figure 4-6. IP Top Level Directory Structure (Clarity Designer) Table 4-3 provides a list of key files and directories created by the Clarity Designer tool and how they are used. The Clarity Designer tool creates several files that are used throughout the design cycle. The names of most of the created files are customized to the user's module name specified in the Clarity Designer tool. IPUG64_01.3, March 2015 22 Gamma Corrector IP Core User Guide IP Core Generation Table 4-3. File List (Clarity Designer) File Description <username>.lpc This file contains the Clarity Designer tool options used to recreate or modify the core in the Clarity Designer tool. <username>.ngo This file provides the synthesized IP core. <username>.ngd This file is used by the Clarity Designer tool to generate the IP core. <username>_bb.v This file provides the synthesis black box for the user's synthesis. <username>_inst.v This file provides an instance template for Gamma Corrector IP core. <username>_beh.v This file provides the front-end simulation library for Gamma Corrector IP core. Table 4-4. Additional Files (Clarity Designer) File Description <username>_generate.tcl This file is created when the GUI Configuration button is pushed. This file may be run from command line. <username>_generate.log This is the synthesis and map log file. <username>_gen.log This is the Clarity Designer IP generation log file. Instantiating the Core The generated Gamma Corrector IP core package includes black-box (<username>_bb.v) and instance (<username>_inst.v) templates that can be used to instantiate the core in a top-level design. An example RTL top-level reference source file that can be used as an instantiation template for the IP core is provided in \<project_dir>\gamma_eval\<username>\src\rtl\top. Users may also use this top-level reference as the starting template for the top-level for their complete design. Running Functional Simulation Simulation support for the Gamma Corrector IP core is provided for the Aldec Active-HDL (Verilog and VHDL) simulator and Mentor Graphics ModelSim simulator. The functional simulation includes a configuration-specific behavioral model of the Gamma Corrector IP core. The test bench sources stimulus to the core, and monitors output from the core. The generated IP core package includes the configuration-specific behavior model (<username>_beh.v) for functional simulation in the "Project Path" root directory. The simulation scripts supporting ModelSim evaluation simulation is provided in \<project_dir>\gamma_eval\<username>\sim\modelsim\scripts. The simulation script supporting Aldec evaluation simulation is provided in \<project_dir>\gamma_eval\<username>\sim\aldec\scripts. Both ModelSim and Active-HDL simulation is supported via test bench files provided in \<project_dir>\gamma_eval\testbench. Models required for simulation are provided in the corresponding \models folder. Users may run the Active-HDL evaluation simulation by doing the following: 1. Open Active-HDL. 2. Under the Tools tab, select Execute Macro. 3. Browse to folder \<project_dir>\gamma_eval\<username>\sim\aldec\scripts and execute one of the "do" scripts shown. IPUG64_01.3, March 2015 23 Gamma Corrector IP Core User Guide IP Core Generation Users may run the ModelSim evaluation simulation by doing the following: 1. Open ModelSim. 2. Under the File tab, select Change Directory and choose the folder <project_dir>\gamma_eval\<username>\sim\modelsim\scripts. 3. Under the Tools tab, select Execute Macro and execute the ModelSim "do" script shown. Note: When the simulation is complete, a pop-up window will appear asking "Are you sure you want to finish?" Choose No to analyze the results. Choosing Yes closes ModelSim. Synthesizing and Implementing the Core in a Top-Level Design Synthesis support for the Gamma Corrector IP core is provided for Lattice Synthesis Engine (LSE) or Synopsys Synplify. The Gamma Corrector IP core itself is synthesized and is provided in NGO format when the core is generated. Users may synthesize the core in their own top-level design by instantiating the core in their top level as described previously and then synthesizing the entire design with either Synplify or LSE synthesis. The top-level file <username>_eval_top.v provided in \<project_dir>\gamma_eval\<username>\src\top supports the ability to implement the Gamma Corrector IP core in isolation. Push-button implementation of this top-level design with either Synplify or LSE is supported via the project files <username>_eval.ldf located in the \<project_dir>\gamma_eval\<username>\impl\synplify or the \<project_dir>\gamma_eval\<username>\impl\LSE directory. To use this project file in Diamond: 1. Choose File > Open > Project. 2. Browse to \<project_dir>\gamma_eval\<username>\impl\(synplify or LSE) in the Open Project dialog box. 3. Select and open <username>.ldf. At this point, all of the files needed to support top-level synthesis and implementation will be imported to the project. 4. Select the Process tab in the left-hand GUI window. 5. Implement the complete design via the standard Diamond GUI flow. Hardware Evaluation The Gamma Corrector IP core supports the Lattice IP hardware evaluation capability, which makes it possible to create versions of the IP core that operate in hardware for a limited period of time (approximately four hours) without requiring the purchase of an IP license. It may also be used to evaluate the core in hardware in user-defined designs. Enabling Hardware Evaluation Choose Project > Active Strategy > Translate Design Settings. The hardware evaluation capability may be enabled/disabled in the Strategy dialog box. It is enabled by default. IPUG64_01.3, March 2015 24 Gamma Corrector IP Core User Guide IP Core Generation Updating/Regenerating the IP Core By regenerating an IP core with the IPexpress or Clarity Designer tool, you can modify any of its settings including device type, design entry method, and any of the options specific to the IP core. Regenerating can be done to modify an existing IP core or to create a new but similar one. Regenerating an IP Core in IPexpress To regenerate an IP core in IPexpress: 1. In IPexpress, click the Regenerate button. 2. In the Regenerate view of IPexpress, choose the IPX source file of the module or IP you wish to regenerate. 3. IPexpress shows the current settings for the module or IP in the Source box. Make your new settings in the Target box. 4. If you want to generate a new set of files in a new location, set the new location in the IPX Target File box. The base of the file name will be the base of all the new file names. The IPX Target File must end with an .ipx extension. 5. Click Regenerate. The module's dialog box opens showing the current option settings. 6. In the dialog box, choose the desired options. To get information about the options, click Help. Also, check the About tab in IPexpress for links to technical notes and user's guides. IP may come with additional information. As the options change, the schematic diagram of the module changes to show the I/O and the device resources the module will need. 7. To import the module into your project, if it's not already there, select Import IPX to Diamond Project (not available in stand-alone mode). 8. Click Generate. 9. Check the Generate Log tab to check for warnings and error messages. 10. Click Close. The IPexpress package file (.ipx) supported by Diamond holds references to all of the elements of the generated IP core required to support simulation, synthesis and implementation. The IP core may be included in a user's design by importing the .ipx file to the associated Diamond project. To change the option settings of a module or IP that is already in a design project, double-click the module's .ipx file in the File List view. This opens IPexpress and the module's dialog box showing the current option settings. Then go to step 6 above. IPUG64_01.3, March 2015 25 Gamma Corrector IP Core User Guide IP Core Generation Regenerating/Recreating the IP Core in Clarity Designer By regenerating an IP core with the Clarity Designer tool, you can modify any of the options specific to an existing IP instance. By recreating an IP core with Clarity Designer tool, you can create (and modify if needed) a new IP instance with an existing LPC/IPX configuration file. Regenerating an IP Core in Clarity Designer Tool To regenerate an IP core in Clarity Designer: 1. In the Clarity Designer Builder tab, right-click on the existing IP instance and choose Config. 2. In the dialog box, choose the desired options. For more information about the options, click Help. You may also click the About tab in the Clarity Designer window for links to technical notes and user guides. The IP may come with additional information. As the options change, the schematic diagram of the module changes to show the I/O and the device resources the module will need. 3. Click Configure. Recreating an IP Core in Clarity Designer Tool To recreate an IP core in Clarity Designer: 1. In the Clarity Designer Catalog tab, click the Import IP tab at the bottom. 2. In the Import IP tab, choose the existing IPX/LPC source file of the module or IP to regenerate. 3. Specify the instance name in Target Instance. Note that this instance name should not be the same as any of the existing IP instances in the current Clarity Design project. 4. Click Import. The module's dialog box opens showing the option settings. 5. In the dialog box, choose the desired options. For more information about the options, click Help. You may also click the About tab in the Clarity Designer window for links to technical notes and user guides. The IP may come with additional information. As the options change, the schematic diagram of the module changes to show the I/O and the device resources the module will need. 6. Click Configure. IPUG64_01.3, March 2015 26 Gamma Corrector IP Core User Guide Chapter 5: Support Resources Lattice Technical Support There are a number of ways to receive technical support as listed below. Lattice Technical Support There are a number of ways to receive technical support. E-mail Support techsupport@latticesemi.com Local Support Contact your nearest Lattice sales office. Internet www.latticesemi.com References * DS1044, ECP5 Family Data Sheet * DS1021, LatticeECP3 Family Data Sheet * DS1009, LatticeXP2 Family Data Sheet Revision History Date Document Version IP Core Version March 2015 1.3 2.0 Change Summary Updated to support ECP5U/M devices. Updated to support Clarity Designer flow. Updated to support LSE synthesis tool. June 2012 01.2 1.3 Updated to support 64-bit and 32-bit versions of Diamond. February 2011 01.2 1.2 Updated to support Lattice Diamond 1.1 and ispLEVER 8.1 SP1 design software. Updated to support LatticeECP3 and LatticeXP2 FPGA families. February 2009 01.1 1.1 Updated to show device utilization using ispLEVER 7.1 SP1. January 2007 01.0 1.0 Initial release. IPUG64_01.3, March 2015 27 Gamma Corrector IP Core User Guide Appendix A: Resource Utilization This appendix gives resource utilization information for Lattice FPGAs using the Gamma Corrector IP core. IPexpress and Clarity Designer are the Lattice IP configuration utilities, and are included as standard features of the Diamond design tools. Details regarding the usage of IPexpress and Clarity Designer can be found in the IPexpress and Diamond help systems. For more information on the Diamond design tools, visit the Lattice web site www.latticesemi.com. Table A-1 lists the parameter settings that were used to derive the performance and utilization data shown in Table A-2, Table A-3, and Table A-4. You can use the IPexpress software tool to help generate new configurations of this IP core. Table A-1. Example Configurations for Gamma Corrector IP Core Architecture Mark all color planes same Number of color planes Configuration 1 Configuration 2 Configuration 3 Sequential Parallel Sequential Yes Yes No 3 3 3 8 12 8 Gamma value Gamma value Gamma value 2.2 2.2 2.2 First Color Plane Data width Gamma function input method Gamma value Gamma function through LUT file NA NA NA Programmable Gamma LUT Yes Yes No 8 12 8 Gamma value Gamma value Gamma value 2.2 2.2 3.0 Second Color Plane Data width Gamma function input method Gamma value Gamma function through LUT file NA NA NA Programmable Gamma LUT Yes Yes No 8 12 8 Gamma value Gamma value Gamma value 2.2 2.2 3.2 Third Color Plane Data width Gamma function input method Gamma value Gamma function through LUT file NA NA NA Programmable Gamma LUT Yes Yes No Yes Yes Yes Implementation Add bypass function Registered input Memory type Output latency Yes Yes Yes Automatic Automatic Automatic 6 5 6 ce No No No sr No No No IPUG64_01.3, March 2015 28 Gamma Corrector IP Core User Guide Resource Utilization ECP5 Devices Table A-2. Performance and Resource Utilization1 Slices LUTs Registers sysMEM EBRs fMAX (MHz) Configuration 1: Sequential architecture, 3 color planes, same color planes 57 27 113 3 270 Configuration 2: Parallel architecture, 3 color planes, same color planes 133 36 265 9 270 Configuration 3: Sequential architecture, 3 color planes, different color planes 52 24 104 3 270 IPexpress User-Configurable Mode 1. Performance and utilization characteristics are generated using LFE5UM-45F-8BG554C with Lattice Diamond 3.4 software. When using this IP core in a different density, speed, or grade within the ECP5 family, performance and utilization may vary. Ordering Part Number The Ordering Part Number (OPN) for all configurations of the Gamma Corrector targeting ECP5 devices is GAMMA-E5-U1. LatticeECP3 Devices Table A-3. Performance and Resource Utilization1 Slices LUTs Registers sysMEM EBRs fMAX (MHz) Configuration 1: Sequential architecture, 3 color planes, same color planes IPexpress User-Configurable Mode 57 33 113 3 305 Configuration 2: Parallel architecture, 3 color planes, same color planes 133 39 265 9 305 Configuration 3: Sequential architecture, 3 color planes, different color planes 52 30 104 3 305 1. Performance and utilization characteristics are generated using LFE3-70EA-7F672C with Lattice Diamond 3.4 software. When using this IP core in a different density, speed, or grade within the LatticeECP3 family, performance and utilization may vary. Ordering Part Number The Ordering Part Number (OPN) for all configurations of the Gamma Corrector targeting LatticeECP3 devices is GAMMA-E3-U1. LatticeXP2 Devices Table A-4. Performance and Resource Utilization1 IPexpress User-Configurable Mode Slices LUTs Registers sysMEM EBRs fMAX (MHz) Configuration 1: Sequential architecture, 3 color planes, same color planes 57 27 113 3 310 Configuration 2: Parallel architecture, 3 color planes, same color planes 133 36 265 9 310 Configuration 3: Sequential architecture, 3 color planes, different color planes 52 24 104 3 310 1. Performance and utilization characteristics are generated using LFXP2-17E-7F484C with Lattice Diamond 3.4 software. When using this IP core in a different density, speed, or grade within the LatticeXP2 family, performance and utilization may vary. Ordering Part Number The Ordering Part Number (OPN) for all configurations of the Gamma Corrector targeting LatticeXP2 devices is GAMMA-X2-U1. IPUG64_01.3, March 2015 29 Gamma Corrector IP Core User Guide Mouser Electronics Authorized Distributor Click to View Pricing, Inventory, Delivery & Lifecycle Information: Lattice: GAMMA-P2-U1 GAMMA-PM-U1 GAMMA-P2-UT1 GAMMA-PM-UT1 GAMMA-X2-UT1 GAMMA-E3-U1 GAMMAE3-UT1 GAMMA-X2-U1