embeddedsw/XilinxProcessorIPLib/drivers/spi/data/spi.tcl

###############################################################################
#
# Copyright (C) 2004 - 2014 Xilinx, Inc.  All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# Use of the Software is limited solely to applications:
# (a) running on a Xilinx device, or
# (b) that interact with a Xilinx device through a bus or interconnect.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# XILINX CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
# OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# Except as contained in this notice, the name of the Xilinx shall not be used
# in advertising or otherwise to promote the sale, use or other dealings in
# this Software without prior written authorization from Xilinx.
#
###############################################################################
##############################################################################
#
# Modification History
#
# Ver   Who  Date     Changes
# ----- ---- -------- -----------------------------------------------
# 3.03a sdm  08/11/10 Added C_SPI_MODE parameter to config structure
# 3.04a bss  03/21/12 Added C_TYPE_OF_AXI4_INTERFACE, C_AXI4_BASEADDR and
#	              C_XIP_MODE to config structure.
# 		      Modified such that based on C_XIP_MODE and 
#		      C_TYPE_OF_AXI4_INTERFACE parameters C_BASEADDR will 
#		      be updated with the value of C_AXI4_BASEADDR.
#		      Modified such that C_FIFO_EXIST will be updated based
#		      on C_FIFO_DEPTH for compatability of driver
# 3.06a adk 07/08/13 Added C_USE_STARTUP parameter to the config structure
# 4.0   adk 12/10/13 Updated as per the New Tcl API's
#
##############################################################################

#uses "xillib.tcl"

set periph_config_params_spi 0
set periph_ninstances_spi    0

proc init_periph_config_struct_spi { deviceid } {
    global periph_config_params_spi
    set periph_config_params_spi($deviceid) [list]
}

proc add_field_to_periph_config_struct_spi { deviceid fieldval } {
    global periph_config_params_spi
    lappend periph_config_params_spi($deviceid) $fieldval
}

proc get_periph_config_struct_fields_spi { deviceid } {
    global periph_config_params_spi
    return $periph_config_params_spi($deviceid)
}

proc xdefine_axispi_include_file {drv_handle file_name drv_string} {
	global periph_ninstances
	
	    # Open include file
	    set file_handle [::hsi::utils::open_include_file $file_name]
	
	    # Get all peripherals connected to this driver
	    set periphs [::hsi::utils::get_common_driver_ips $drv_handle]
	
	    # Handle NUM_INSTANCES
	    set periph_ninstances 0
	    puts $file_handle "/* Definitions for driver [string toupper [get_property NAME $drv_handle]] */"
	    foreach periph $periphs {
	    	init_periph_config_struct_spi $periph_ninstances
	    	incr periph_ninstances 1
	    }
	    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $drv_string NUM_INSTANCES] $periph_ninstances"
	
	
	    # Now print all useful parameters for all peripherals
	    set device_id 0
	    foreach periph $periphs {
        	puts $file_handle ""
        	
        	xdefine_axispi_params_instance $file_handle $periph $device_id
        	
        	xdefine_axispi_params_canonical $file_handle $periph $device_id
        	incr device_id
            	puts $file_handle "\n"
           }
           puts $file_handle "\n/******************************************************************/\n"
    	   close $file_handle
}

proc xdefine_axispi_params_instance {file_handle periph device_id} {
	set ip [hsi::get_cells $periph]
    set xip_mode_value [get_property  CONFIG.C_XIP_MODE $ip]
    if {[llength $xip_mode_value] == 0} {
         set xip_mode_value 0
    }
    set axi_type_value [get_property CONFIG.C_TYPE_OF_AXI4_INTERFACE $periph]
    if {[llength $axi_type_value] == 0} {
         set axi_type_value 0
    }
    set axi4_baseaddr_value [get_property CONFIG.C_S_AXI4_BASEADDR $periph]
    if {[llength $axi4_baseaddr_value] == 0} {
             set axi4_baseaddr_value 0
    }
    set axi4_highaddr_value [get_property CONFIG.C_S_AXI4_HIGHADDR $periph]
    if {[llength $axi4_highaddr_value] == 0} {
             set axi4_highaddr_value 0
    }
    puts $file_handle "/* Definitions for peripheral [string toupper [get_property NAME $periph]] */"
    
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "DEVICE_ID"] $device_id"
    if {$xip_mode_value == 0} {
    	if {$axi_type_value == 0} { 
		puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "BASEADDR"] [get_property CONFIG.C_BASEADDR $periph]"
		puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph HIGHADDR] [get_property CONFIG.C_HIGHADDR $periph]"
    	} else {
		puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "BASEADDR"] $axi4_baseaddr_value"
		puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph HIGHADDR] $axi4_highaddr_value"
    	}
    } else {
	puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "BASEADDR"] [get_property CONFIG.C_BASEADDR $periph]"
	puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph HIGHADDR] [get_property CONFIG.C_HIGHADDR $periph]"
    }
    
    set value [get_property CONFIG.C_FIFO_EXIST $periph]
    if {[llength $value] == 0} {
         set value1 [get_property CONFIG.C_FIFO_DEPTH $periph]
         if {[llength $value1] == 0} {
    	    set value1 0
         } else {
           set value1 [get_property CONFIG.C_FIFO_DEPTH $periph]
           puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "FIFO_DEPTH"] $value1"
           if {$value1 == 0} {
              set value1 0
           } else {
              set value1 1
           }
        }
    } else {
        set value1 $value
    }
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "FIFO_EXIST"] $value1"
    
    set value [get_property CONFIG.C_SPI_SLAVE_ONLY $periph]
    if {[llength $value] == 0} {
	set value 0
    }
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "SPI_SLAVE_ONLY"] $value"
    set value [get_property CONFIG.C_NUM_SS_BITS $periph]
    if {[llength $value] == 0} {
    	set value 0
    }
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "NUM_SS_BITS"] $value"
    set value [get_property CONFIG.C_NUM_TRANSFER_BITS $periph]
    if {[llength $value] == 0} {
        set value 0
    }
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "NUM_TRANSFER_BITS"] $value"
    set value [get_property CONFIG.C_SPI_MODE $periph]
    if {[llength $value] == 0} {
            set value 0
    }
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "SPI_MODE"] $value"
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "TYPE_OF_AXI4_INTERFACE"] $axi_type_value"
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "AXI4_BASEADDR"] $axi4_baseaddr_value"
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "AXI4_HIGHADDR"] $axi4_highaddr_value"
    puts $file_handle "\#define [::hsi::utils::get_driver_param_name $periph "XIP_MODE"] $xip_mode_value"
}

proc xdefine_axispi_params_canonical {file_handle periph device_id} {

    set xip_mode_value [get_property CONFIG.C_XIP_MODE $periph]
    if {[llength $xip_mode_value] == 0} {
      set xip_mode_value 0
    }
    set axi_type_value [get_property CONFIG.C_TYPE_OF_AXI4_INTERFACE $periph]
    if {[llength $axi_type_value] == 0} {
       set axi_type_value 0
    }
    set axi4_baseaddr_value [get_property CONFIG.C_S_AXI4_BASEADDR $periph]
    if {[llength $axi4_baseaddr_value] == 0} {
	 set axi4_baseaddr_value 0
    }
    set axi4_highaddr_value [get_property CONFIG.C_S_AXI4_HIGHADDR $periph]
    if {[llength $axi4_highaddr_value] == 0} {
	 set axi4_highaddr_value 0
    }
    
    set use_startup_value [get_property CONFIG.C_USE_STARTUP $periph]
    if {[llength $use_startup_value] == 0} {
	set use_startup_value 0
    }
    
    puts $file_handle "\n/* Canonical definitions for peripheral [string toupper [get_property NAME $periph]] */"

    set canonical_tag [string toupper [format "XPAR_SPI_%d" $device_id]]

    # Handle device ID
    set canonical_name  [format "%s_DEVICE_ID" $canonical_tag]
    puts $file_handle "\#define $canonical_name $device_id"
    add_field_to_periph_config_struct_spi $device_id $canonical_name

    if {$xip_mode_value == 0} {
	if {$axi_type_value == 0} { 
		set canonical_name  [format "%s_BASEADDR" $canonical_tag]
		puts $file_handle "\#define $canonical_name [get_property CONFIG.C_BASEADDR $periph]"
                add_field_to_periph_config_struct_spi $device_id $canonical_name
                set canonical_name  [format "%s_HIGHADDR" $canonical_tag]
                puts $file_handle "\#define $canonical_name [get_property CONFIG.C_HIGHADDR $periph]"
	} else {
		set canonical_name  [format "%s_BASEADDR" $canonical_tag]
		puts $file_handle "\#define $canonical_name $axi4_baseaddr_value"
                add_field_to_periph_config_struct_spi $device_id $canonical_name
		set canonical_name  [format "%s_HIGHADDR" $canonical_tag]
                puts $file_handle "\#define $canonical_name $axi4_highaddr_value"
	}
    } else {
        set canonical_name  [format "%s_BASEADDR" $canonical_tag]
	puts $file_handle "\#define $canonical_name [get_property CONFIG.C_BASEADDR $periph]"
	add_field_to_periph_config_struct_spi $device_id $canonical_name
	set canonical_name  [format "%s_HIGHADDR" $canonical_tag]
        puts $file_handle "\#define $canonical_name [get_property CONFIG.C_HIGHADDR $periph]"
    }
    set canonical_name  [format "%s_FIFO_EXIST" $canonical_tag]
    set value [get_property CONFIG.C_FIFO_EXIST $periph]
    if {[llength $value] == 0} {
        set value1 [get_property CONFIG.C_FIFO_DEPTH $periph]
        if {[llength $value1] == 0} {
	    set value1 0
    	} else {
    	   set canonical_name1  [format "%s_FIFO_DEPTH" $canonical_tag]
    	   puts $file_handle "\#define $canonical_name1 $value1"	   
    	   if {$value1 == 0} {
    	   	set value1 0
    	   } else {
    	   	set value1 1
    	   }
    	}
    } else {
    	set value1 $value
    }
    puts $file_handle "\#define $canonical_name $value1"
    add_field_to_periph_config_struct_spi $device_id $canonical_name
    
    set canonical_name  [format "%s_SPI_SLAVE_ONLY" $canonical_tag]
    set value [get_property CONFIG.C_SPI_SLAVE_ONLY $periph]
    if {[llength $value] == 0} {
    	set value 0
    }
    puts $file_handle "\#define $canonical_name $value"
    add_field_to_periph_config_struct_spi $device_id $canonical_name

    set canonical_name  [format "%s_NUM_SS_BITS" $canonical_tag]
    set value [get_property CONFIG.C_NUM_SS_BITS $periph]
    if {[llength $value] == 0} {
        set value 0
    }
    puts $file_handle "\#define $canonical_name $value"
    add_field_to_periph_config_struct_spi $device_id $canonical_name

    set canonical_name  [format "%s_NUM_TRANSFER_BITS" $canonical_tag]
    set value [get_property CONFIG.C_NUM_TRANSFER_BITS $periph]
    if {[llength $value] == 0} {
    	set value 0
    }
    puts $file_handle "\#define $canonical_name $value"
    add_field_to_periph_config_struct_spi $device_id $canonical_name

    set canonical_name  [format "%s_SPI_MODE" $canonical_tag]
    set value [get_property CONFIG.C_SPI_MODE $periph]
    if {[llength $value] == 0} {
       	set value 0
    }
    puts $file_handle "\#define $canonical_name $value"
    add_field_to_periph_config_struct_spi $device_id $canonical_name

    set canonical_name  [format "%s_TYPE_OF_AXI4_INTERFACE" $canonical_tag]
    puts $file_handle "\#define $canonical_name $axi_type_value"
    add_field_to_periph_config_struct_spi $device_id $canonical_name

    set canonical_name  [format "%s_AXI4_BASEADDR" $canonical_tag]
    puts $file_handle "\#define $canonical_name $axi4_baseaddr_value"
    add_field_to_periph_config_struct_spi $device_id $canonical_name

    set canonical_name  [format "%s_AXI4_HIGHADDR" $canonical_tag]
    puts $file_handle "\#define $canonical_name $axi4_highaddr_value"
    
    set canonical_name  [format "%s_XIP_MODE" $canonical_tag]
    puts $file_handle "\#define $canonical_name $xip_mode_value"
    add_field_to_periph_config_struct_spi $device_id $canonical_name
    
    set canonical_name  [format "%s_USE_STARTUP" $canonical_tag]
    puts $file_handle "\#define $canonical_name $use_startup_value"
    add_field_to_periph_config_struct_spi $device_id $canonical_name
}

proc xdefine_axispi_config_file {file_name drv_string} {

    global periph_ninstances

    set filename [file join "src" $file_name]
    file delete $filename
    set config_file [open $filename w]
    ::hsi::utils::write_c_header $config_file "Driver configuration"
    puts $config_file "\#include \"xparameters.h\""
    puts $config_file "\#include \"[string tolower $drv_string].h\""
    puts $config_file "\n/*"
    puts $config_file "* The configuration table for devices"
    puts $config_file "*/\n"
    puts $config_file [format "%s_Config %s_ConfigTable\[\] =" $drv_string $drv_string]
    puts $config_file "\{"

    set start_comma ""
    for {set i 0} {$i < $periph_ninstances} {incr i} {

        puts $config_file [format "%s\t\{" $start_comma]
        set comma ""
        foreach field [get_periph_config_struct_fields_spi $i] {
            puts -nonewline $config_file [format "%s\t\t%s" $comma $field]
            set comma ",\n"
        }

        puts -nonewline $config_file "\n\t\}"
        set start_comma ",\n"
    }
    puts $config_file "\n\};\n"
    close $config_file
}

proc generate {drv_handle} {
    xdefine_axispi_include_file $drv_handle "xparameters.h" "XSpi"
    xdefine_axispi_config_file  "xspi_g.c" "XSpi"
}