IEEE-1076C-2007.pdf

IEEE Std 1076c-2007 (Amendment to IEEE Std 1076-2002) IEEE Standard VHDL Language Reference Manual Amendment 1: Procedural Language Application Interface IEEE 3 Park Avenue New York, NY 10016-5997, USA 5 September 2007 IEEE Computer Society Sponsored by the Design Automation Standards Committee 1076c TM Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- IEEE Std 1076c -2007 (Amendment to IEEE Std 1076 -2002) IEEE Standard VHDL Language Reference Manual Amendment 1: Procedural Language Application Interface Sponsor Design Automation Standards Committee of the IEEE Computer Society Approved 8 March 2007 IEEE SA-Standards Board Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- The Institute of Electrical and Electronics Engineers, Inc. 3 Park Avenue, New York, NY 10016-5997, USA Copyright © 2007 by the Institute of Electrical and Electronics Engineers, Inc. All rights reserved. Published 5 September 2007. Printed in the United States of America. IEEE is a registered trademark in the U.S. Patent +1 978 750 8400. Permission to photocopy portions of any individual standard for educational classroom use can also be obtained through the Copyright Clearance Center. Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- iv Copyright © 2007 IEEE. All rights reserved. Introduction The VHSIC Hardware Description Language (VHDL) is a formal notation intended for use in all phases of the creation of electronic systems. Because it is both machine readable and human readable, it supports the development, verification, synthesis, and testing of hardware designs; the communication of hardware design data; and the maintenance, modification, and procurement of hardware. This document is an amendment to IEEE Std 1076-2002. The main change is the addition of the VHDL Pro- cedural Interface (VHPI), which allows external programs to access information about a VHDL description processed by a VHDL tool. The amendment also includes a minor change to clarify the rules for scope of architecture bodies. The maintenance of the VHDL language standard is an ongoing process. The chair of the VHDL Analysis and Standardization Group (VASG), otherwise known as the 1076 Working Group, extends his gratitude to all who have participated in this amendment. In particular, the VHDL community owes a debt of gratitude to the members of the VHPI Task Force, who have devoted many hours of effort over an extended period to prepare this specification. Notice to users Errata Errata, if any, for this and all other standards can be accessed at the following URL: http:/ standards.ieee.org/reading/ieee/updates/errata/index.html. Users are encouraged to check this URL for errata periodically. Interpretations Current interpretations can be accessed at the following URL: http:/standards.ieee.org/reading/ieee/interp/ index.html. Patents Attention is called to the possibility that implementation of this standard may require use of subject matter covered by patent rights. By publication of this standard, no position is taken with respect to the existence or validity of any patent rights in connection therewith. The IEEE shall not be responsible for identifying patents or patent applications for which a license may be required to implement an IEEE standard or for conducting inquiries into the legal validity or scope of those patents that are brought to its attention. This introduction is not part of IEEE Std 1076c-2007, IEEE Standard VHDL Language Reference Manual Amendment 1: Procedural Language Application Interface. Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- Copyright © 2007 IEEE. All rights reserved. v Participants The following individuals participated as members of the VHPI Task Force in the development of this amendment: Françoise Martinolle, Chair Peter J. Ashenden, Technical Editor The following individuals participated as members of the P1076 Working Group: Jim W. Lewis, Chair Charles Swart, Vice Chair Peter J. Ashenden, Secretary The following members of the individual balloting committee voted on this standard. Balloters may have voted for approval, disapproval, or abstention. Stephen A. Bailey Mikhail Brodsky Patrick Bryant Debi Dalio Steven J. Dovich Tristan Gingold Frank Guerino Amit Kohli Jim W. Lewis Paul Menchini Vishwanath Raman John J. Shields David Townsend John C. Willis Debra Wimpey Alex Zamfirescu John Aynsley Stephen A. Bailey Victor Berman Françoise Martinolle Egbert Molenkamp Robert J. Myers John P. Ries Sukrit Shankar John J. Shields Ajayharsh Varikat John C. Willis Mark Zwolinski Peter J. Ashenden Stephen A. Bailey Victor Berman Dennis B. Brophy Juan C. Carreon James S. Case Danila Chernetsov Keith Chow Ernst Christen S. M. Claassen Tommy P. Cooper Thomas J. Dineen Steven J. Dovich Sourav K. Dutta George E. Economakos John W. Fendrich Randall C. Groves M. K. Hashmi Werner Hoelzl Jim W. Lewis G. L. Luri Françoise Martinolle Gary L. Michel Michael D. Mirmak Egbert Molenkamp Robert J. Myers Michael S. Newman William R. Paulsen Gregory D. Peterson Ulrich Pohl Iulian E. Profir Vikram Punj Vishwanath Raman John P. Ries Stephen C. Schwarm John J. Shields David W. Smith Charles Swart Lance G. Thompson Mark-Rene Uchida Joe T. Uchiyama Alain Vachoux Srinivasa R. Vemuru John C. Willis Oren Yuen Janusz Zalewski Mark Zwolinski Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- vi Copyright © 2007 IEEE. All rights reserved. When the IEEE-SA Standards Board approved this standard on 8 March 2007, it had the following membership: Steve M. Mills, Chair Robert M. Gown, Vice Chair Don Wright, Past Chair Judith Gorman, Secretary *Member Emeritus Also included are the following nonvoting IEEE-SA Standards Board liaisons: Satish K. Aggarwal, NRC Representative Alan H. Cookson, NIST Representative Virginia C. Sulzberger, Member/TAB Representative Don Messina IEEE Standards Program Manager, Document Development Michael D. Kipness IEEE Standards Program Manager, Technical Program Development Richard DeBlasio Alex Gelman William R. Goldbach Arnold M. Greenspan Joanna N. Guenin Julian Forster* Kenneth S. Hanus William B. Hopf Richard H. Hulett Hermann Koch Joseph L. Koepfinger* John Kulick David J. Law Glenn Parsons Ronald C. Petersen Tom A. Prevost Narayanan Ramachandran Greg Ratta Robby Robson Anne-Marie Sahazizian Virginia C. Sulzberger* Malcolm V. Thaden Richard L. Townsend Howard L. Wolfman Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- Copyright © 2007 IEEE. All rights reserved vii Contents 0. Overview of this standard 1 0.2 Structure and terminology of this standard 1 1.Design entities and configurations 3 1.2Architecture bodies 3 2.Subprograms and packages . 5 2.1Subprogram declarations 5 5.Specifications 7 5.1Attribute specification 7 6.Names 9 6.3Selected names . 9 8.Sequential statements 11 8.5Variable assignment statement. 11 9.Concurrent statements. 13 9.6Component instantiation statements 13 10.Scope and visibility. 17 10.1 Declarative region 17 10.2 Scope of declarations . 17 10.3 Visibility. 18 12.Elaboration and execution. 19 12.1 Elaboration of a design hierarchy 19 12.3 Elaboration of a declarative part 19 12.4 Elaboration of a statement part 19 12.5 Dynamic elaboration 20 12.6 Execution of a model . 20 15.VHDL Procedural Interface overview 31 15.1 Organization of the interface 31 15.2 Capability sets 32 15.3 Handles . 34 Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- viii Copyright © 2007 IEEE. All rights reserved. 16.VHPI access functions 37 16.1 Information access functions . 37 16.2 Property access functions. 39 16.3 Access by name functions 40 17.VHPI information model . 41 17.1 Formal notation . 41 17.2 Class inheritance hierarchy . 42 17.3 Name properties 42 17.4 The stdUninstantiated package 56 17.5 The stdHierarchy package. 59 17.6 The stdTypes package . 68 17.7 The stdExpr package. 70 17.8 The stdSpec package . 74 17.9 The stdSubprograms package 76 17.10 The stdStmts package 78 17.11 The stdConnectivity package 84 17.12 The stdCallbacks package . 88 17.13 The stdEngine package 89 17.14 The stdForeign package. 89 17.15 The stdMeta package. 90 17.16 The stdTool package . 92 17.17 Application contexts 93 18.VHPI tool execution 95 18.1 Registration phase 95 18.2 Analysis phase 101 18.3 Elaboration phase. 101 18.4 Initialization phase. 103 18.5 Simulation phase 103 18.6 Save phase 103 18.7 Restart phase 104 18.8 Reset phase . 104 18.9 Termination phase 105 19.VHPI callbacks 107 19.1 Callback functions 107 19.2 Callback reasons 108 20.VHPI value access and update 121 20.1 Value structures and types . 121 20.2 Reading object values 125 20.3 Formatting values. 126 20.4 Updating object values. 127 20.5 Scheduling transactions on drivers 131 Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- Copyright © 2007 IEEE. All rights reserved ix 21.VHPI function reference . 135 21.1 vhpi_assert . 135 21.2 vhpi_check_error . 136 21.3 vhpi_compare_handles 138 21.4 vhpi_control . 139 21.5 vhpi_create 141 21.6 vhpi_disable_cb . 143 21.7 vhpi_enable_cb 143 21.8 vhpi_format_value . 144 21.9 vhpi_get . 146 21.10 vhpi_get_cb_info . 146 21.11 vhpi_get_data 147 21.12 vhpi_get_foreignf_info 149 21.13 vhpi_get_next_time . 150 21.14 vhpi_get_phys . 151 21.15 vhpi_get_real . 152 21.16 vhpi_get_str . 152 21.17 vhpi_get_time 153 21.18 vhpi_get_value 154 21.19 vhpi_handle . 155 21.20 vhpi_handle_by_index 156 21.21 vhpi_handle_by_name . 158 21.22 vhpi_is_printable. 160 21.23 vhpi_iterator 161 21.24 vhpi_printf . 162 21.25 vhpi_protected_call . 163 21.26 vhpi_put_data 165 21.27 vhpi_put_value 167 21.28 vhpi_register_cb 168 21.29 vhpi_register_foreignf . 169 21.30 vhpi_release_handle 171 21.31 vhpi_remove_cb 172 21.32 vhpi_scan . 172 21.33 vhpi_schedule_transaction 173 21.34 vhpi_vprintf . 176 Annex B (informative) Glossary . 179 Annex F (informative) Bibliography 185 Annex G (normative) VHPI header file 187 Annex H (informative) Description of accompanying files 213 Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- Copyright © 2007 IEEE. All rights reserved. 1 IEEE Standard VHDL Language Reference Manual Amendment 1: Procedural Language Application Interface NOTEThe editing instructions contained in this amendment define how to merge the material contained therein into the existing base standard and its amendments to form the comprehensive standard. The editing instructions are shown in bold italic. Four editing instructions are used: change, delete, insert, and replace. Change is used to make small corrections in existing text or tables. The editing instruction specifies the location of the change and describes what is being changed by using strikethrough (to remove old material) or underscore (to add new material). Delete removes existing material. Insert adds new material without disturbing the existing material. Insertions may require renumbering. If so, renumbering instructions are given in the editing instruction. Replace is used to make changes in figures or equations by removing the existing figure or equation and replacing it with a new one. Editorial notes will not be carried over into future editions because the changes will be incorporated into the base standard. 0. Overview of this standard 0.2 Structure and terminology of this standard 0.2.3 Front matter, examples, notes, references, and annexes Change the fi rst paragraph in 0.2.3 as shown: Prior to this subclause are several pieces of introductory material; following Clause 14 21 are some annexes and an index. The front matter, annexes (except Annex G), and index serve to orient and otherwise aid the user of this standard, but are not part of the defi nition of VHDL; Annex G, however, is normative. Copyright The Institute of Electrical and Electronics Engineers, Inc. Provided by IHS under license with IEEELicensee=IHS Employees/1111111001, User=Wing, Bernie Not for Resale, 10/05/2007 02:30:15 MDTNo reproduction or networking permitted without license from IHS -,-,- 2 Copyright © 2007