.NLIST ; ; Version: 'X-61' ; .LIST ME ; ;**************************************************************************** ;* * ;* COPYRIGHT (c) 1990, 1991, 1993, 1994 * ;* DIGITAL EQUIPMENT CORPORATION, MAYNARD, MASSACHUSETTS. * ;* ALL RIGHTS RESERVED. * ;* * ;* THIS SOFTWARE IS FURNISHED UNDER A LICENSE AND MAY BE USED AND COPIED * ;* ONLY IN ACCORDANCE WITH THE TERMS OF SUCH LICENSE AND WITH THE * ;* INCLUSION OF THE ABOVE COPYRIGHT NOTICE. THIS SOFTWARE OR ANY OTHER * ;* COPIES THEREOF MAY NOT BE PROVIDED OR OTHERWISE MADE AVAILABLE TO ANY * ;* OTHER PERSON. NO TITLE TO AND OWNERSHIP OF THE SOFTWARE IS HEREBY * ;* TRANSFERRED. * ;* * ;* THE INFORMATION IN THIS SOFTWARE IS SUBJECT TO CHANGE WITHOUT NOTICE * ;* AND SHOULD NOT BE CONSTRUED AS A COMMITMENT BY DIGITAL EQUIPMENT * ;* CORPORATION. * ;* * ;* DIGITAL ASSUMES NO RESPONSIBILITY FOR THE USE OR RELIABILITY OF ITS * ;* SOFTWARE ON EQUIPMENT WHICH IS NOT SUPPLIED BY DIGITAL. * ;* * ;* * ;**************************************************************************** ;++ ; ; FACILITY: EVMS System Macro Libraries ; ; ABSTRACT: ; ; This file contains macros that are commonly used by the ; EVMS executive and drivers. ; ; ENVIRONMENT: ; ; n/a ; ;-- ; ; ; AUTHOR: The VMS Group CREATION DATE: 19-Apr-1990 ; ; MODIFIED BY: ; ; X-61 RCL Rick Lord 26-Mar-1996 ; Add new macro SPI$INITIAL_PROCESSING for use by the ; SCSI class drivers. ; ; X-60 PJH Paul J. Houlihan 29-Jun-1995 ; Get rid of a temporary macro and change default of the ; pending I/O routine. ; ; X-59 LSS0350 Leonard S. Szubowicz 28-Jun-1995 ; Change the Step 2 driver sub-version that is initialized by the ; DPTAB macro to DPT$K_STEP2_V5 for Theta EFT. See edit X-14 ; to DPTDEF.SDL. ; ; X-58 PJH Paul J. Houlihan 26-Jun-1995 ; Add new driver entry macro for pending I/O routine. ; ; X-57 PJH Paul J. Houlihan 22-Jun-1995 ; Add initialization of new DDT routine vector cell to DDTAB. ; ; X-56 LSS0345 Leonard S. Szubowicz 27-Apr-1995 ; Change the Step 2 driver sub-version that is initialized by the ; DPTAB macro to DPT$K_STEP2_V4 for Theta IFT. See edit X-13 ; to DPTDEF.SDL. ; ; X-55 DED Denise E. Dumas 9-Mar-1995 ; Fast Path support: add INITIATE_SETUP, INCREMENT_IOCNT, ; CALL_REQCOM_LOCAL, IOFORK_CPU, IPINT_CPU_FAST, and ; MSCP_IO_SETUP. ; ; X-54 LSS0320 Leonard S. Szubowicz 16-Feb-1995 ; 64-Bit Virtual Addressing: Modify the CALL_READCHK, ; CALL_READCHKR, CALL_READLOCK, CALL_READLOCK_ERR, CALL_WRITECHK, ; CALL_WRITECHKR, CALL_WRITELOCK, CALL_WRITELOCK_ERR, ; CALL_MODIFYLOCK, and CALL_MODIFYLOCK_ERR macros to handle ; 64-bit buffer addresses. ; ; X-53 JCH703a John C. Hallyburton, Jr. 17-Jan-1995 ; Fix FAST_FDT table entry in DDTAB to generate a reference ; to the "real" FAST_FDT code entry. ; ; X-52 LSS0313 Leonard S. Szubowicz 4-Nov-1994 ; Change X-51 to reflect last minute change to X-47U1. ; DPT_STORE_DIPL macro should call IOC$SETUP_UCB_DIPL with only ; the UCB pointer as a parameter. ; ; X-51 LSS0313 Leonard S. Szubowicz 3-Nov-1994 ; Fold X-47U1 from Zeta. ; Add DPT_STORE_DIPL macro which can be used instead of ; "DPT_STORE UCB,UCB$B_DIPL,dipl_const" to load the platform- ; specific DIPL for the adapter. See STAR::EVMS_IO note 378.13 ; for details. ; ; X-50 LSS0312 Leonard S. Szubowicz 24-Oct-1994 ; Change the Step 2 driver sub-version that is initialized by the ; DPTAB macro to DPT$K_STEP2_V3 because of the various I/O data ; structure changes that are necessary to support 64-bits and ; Fast I/O. See edit X-12 to DPTDEF.SDL. ; ; X-49 LSS0311 Leonard S. Szubowicz 17-Oct-1994 ; Add FDT_64 macro to allow drivers to declare what functions ; can accept a 64-bit $QIO P1 parameter. Initialize the new ; FDT$Q_OK64BIT cell in the FDT_INI macro. See "Chapter 20: QIO ; and Device Drivers" in DOCD$:[EVMS.CMS_64B]DS-64BITS.PS. ; ; X-48 JCH703 John C. Hallyburton, Jr. 5-Oct-1994 ; Update DDTAB to correspond to Fast-IO DDT addition. ; Correct typo in IOFORK descriptive comment. ; ; X-47 JFD0558 James F. Dunham 3-AUG-1994 ; Change SPI$CONNECT to pass a port state context value along ; with the port_state_callback routine address ; ; X-47 JFD0498 James F. Dunham 19-MAY-1994 ; 1). Change arguments to SC$CMD_BUFFER_ALLOC to not require ; return size address ; 2). Include all SCSI-2 data structures in SCQ$ version checks ; 3). Correct argument order fo ACA_START_PROCESSING and ACA_END_PROCESSING ; 4). Fix initialization of SCQ$PS_PORT_STATE_CALLBACK ; ; X-47-0 JFD0254 James F. Dunham 1-APR-1994 ; Add updated SPI$, PORT$ and COMM$ macros for the SCSI-2 ; Class / Common / Port Interfaces ; ; X-46 RAR032 Buzzy Ritter 11-Mar-1994 ; Fix default TYPE parameter in SPI$RESET to match traditional ; behavior. ; ; X-45 ROW0844 Ralph O. Weber 21-DEC-1993 11:48 ; Update DPT$IW_STEPVER to signal data structure changes ; created in ROW0842. ; ; X-44 ROW0842 Ralph O. Weber 16-DEC-1993 16:20 ; Add DPTAB setup for DPT$IW_IOHANDLES. Add DDTAB setup for ; DDT$PS_CSR_MAPPING. These two new fields are part of driver- ; based PCI bus CSR mapping support. ; ; X-43 RCL Rick Lord 4-Nov-93 ; ; Remove SPI$ macros for calling the SCSI port driver ; target mode routines. The SPDT vectors for these ; routines have been removed because target mode is ; not currently supported. ; ; X-42 JCN Jan Nordh 29-Sep-1993 ; Convert all SPI$ macros from JSB to CALL interfaces. ; Merged LPL1015 with my edits. ; LPL1015 Lee Leahy 8 Jul 1993 ; 1.) Modified SP1/SPI$SEND_COMMAND macro: ; Added the type parameter. ; Initialized the SCDRP$IS_QUEUE_CHAR field using the type parameter. ; 2.) Added the following MACROS: ; SPI$FREEZE_QUEUE ; SPI$RELEASE_QUEUE ; SPI$FLUSH_QUEUE ; 3.) Modified SP1/SPI$RESET macro: ; Added the type parameter. ; When type != BUS, call SPDT$PS_RESET_DEVICE instead ; of SPDT$L_RESET. ; 4.) Modify SP1/SPI$CONNECT macro: ; Add PORT_CALLBACK parameter. ; Initialize SCDT$PS_PORT_CALLBACK ; ; X-41 LSS293 Leonard S. Szubowicz 10-Sep-1993 ; HLLDD: Add an consistency check to try to catch inappropriate ; usage of DDTAB JSB_START and a call entry $DRIVER_START_ENTRY. ; This consistency check only works if both are in the same ; module, but should be useful nonetheless. ; ; X-40 LSS0291 Leonard S. Szubowicz 9-Sep-1993 ; HLLDD: Remove support for STEP=1 drivers: Change DPTAB, DDTAB, ; macros. FUNCTAB is obsolete, but informs about its replacement. ; Also, treat invalid values for YES/NO parameters (and similar ; keyword parameters) on step 2 macros as errors instead of ; warnings. And, remove old $x macros (see edits X-35 and X-37). ; ; X-39 LSS0289 Leonard S. Szubowicz 3-Sep-1993 ; In DPTAB, change the informational message about the ; obsolescence of STEP=1 drivers, now that it is fast approaching, ; to a more noticable warning. ; ; X-38 DEE0195 David E. Eiche 25-Aug-1993 ; Make FDT label a global symbol for HLL driver table support. ; ; X-37 LSS0283 Leonard S. Szubowicz 18-Aug-1993 ; HLLDD: Generate warning messages in old $x macros to use CALL_x ; instead. These macros will be removed in FT3. (see X-35) ; Also, add support for PRESERVE= to $DRIVER_x_ENTRY macros. ; ; X-36 WDB:HLL066 Walter D. Blaschuk, Jr. 18-AUG-1993 ; HLLDD Project: Remove the generic offdefs in the ; $DRIVER_entrypoint_ENTRY macros. ; ; X-35 WDB:HLL065 Walter D. Blaschuk, Jr. 04-AUG-1993 ; HLLDD Project: Change the Step 2 macros to use ; "CALL_" as a prefix rather than "$". ; ; X-33 LSS0276 Leonard S. Szubowicz 9-Jul-1993 ; Add DDTAB JSB_START and JSB_ALTSTART for step 2 drivers that ; continue to use a JSB start I/O and fork environment. ; ; X-32 LSS0276 Leonard S. Szubowicz 1-Jul-1993 ; Use the .GLOBAL directive instead of .EXTERNAL. The .EXTERNAL ; directive does not allow the symbol to be defined by the current ; module. However, .GLOBAL allows the symbol to be defined ; in the current module as well as externally (see X-31, X-17). ; ; X-31 LSS0276 Leonard S. Szubowicz 28-Jun-1993 ; Add .EXTERNAL directives for new routine references added by ; edit X-30. This makes these macros function transparently ; in environments that use the .DISABLE GLOBAL directive. ; ; X-30 LSS0276 Leonard S. Szubowicz 24-Jun-1993 ; Add support for callable fork routines as in EVMS$IO_CMS: ; HLLDD-FORK.MEM to the FORK, FORK_ROUTINE, FORK_WAIT, IOFORK, ; RELCHAN, REQCOM, REQCHAN, REQPCHAN, WFIKPCH, and WFIRLCH macros. ; ; X-29 WDB:HLL060C Walter D. Blaschuk, Jr. 03-JUN-1993 ; HLLDD Project: Change names of offsets to inbound ; driver routines. ; ; X-28 WDB:HLL060C Walter D. Blaschuk, Jr. 03-JUN-1993 ; HLLDD Project: FDT Support routine Macros bugs. ; Fix COM_STD$SETATTNAST again ; ; X-27 WDB:HLL060B Walter D. Blaschuk, Jr. 20-MAY-1993 ; HLLDD Project: FDT Support routine Macros bugs. ; 1)COM_STD$SETATTNAST and COM_STD$SETCTRLAST will ; conditionally return on error, ; 2)$DRIVER_FDT_ENTRY will now, by default, preserve ; R2-R15. ; ; X-26 WDA Walter D. Arbo 06-May-1993 ; Make ARG names to $OFFSET macros consistent across ; for the $DRIVER__ENTRY macros. ; ; X-25 WDB:HLL060A Walter D. Blaschuk, Jr. 12-APR-1993 ; HLLDD Project: FDT Support routine Macros ; Added to the *LOCK_ERR support routine macros an ; interface warning alerting the user that the error ; callback routines must have the standard call ; interface. ; ; X-24 WDB:HLL060 Walter D. Blaschuk, Jr. 25-MAR-1993 ; HLLDD Project: FDT Support routine Macros ; Alter some support routine macros so the interface ; is identical to the Step 1 JSB interfaces. ; ; X-23 DEE0176 David E. Eiche 05-Mar-1993 ; Restore DDT$PS_MNTV_SSSC and DDT$PS_MNTV_SQD to DDTAB ; pending changes to the host-based shadowing code. ; ; X-22 LSS0269 Leonard S. Szubowicz 4-Mar-1993 ; Edit X-21 prematurely removed the definition of the symbol ; EVMS$DRIVER_DPT from the DPTAB macro. DPTAB will still ; define this symbol if the driver is a step 1 driver and it ; has not overridden the default DPT name. ; ; X-21 LSS0267 Leonard S. Szubowicz 26-Feb-1993 ; In the DDTAB macro, use $$STEP for all step dependent ; conditionals once a value for $$STEP is assured. The STEP ; parameter is optional and may not have been specified. ; In FDT_INI, do not save and restore current PSECT which is ; problematic if the current PSECT is DRIVER_DATA. ; Also, in DPTAB, remove definition of EVMS$DRIVER_DPT symbol. ; ; X-20 WDA W.D.Arbo 18-Feb-1993 ; Make corrections to macros added in X-19. ; Make DPT corrections for X-18. Bump STEPVER to 2. ; Change IOC$CANCEL to IOC$CANCELIO inside DDTAB. ; ; X-19 WDA W.D.Arbo 11-Feb-1993 ; Add macros for converting Step 1 inbound driver routines ; written in Macro-32 to Step 2. These macros define symbolic ; AP offsets for the arguments and optionally move the arguments ; into the expected registers. ; ; X-18 DEE0174 David E. Eiche 26-Jan-1993 ; Fix typos in the new FDT_xxx macros. Fix the FUNCTB reference ; in the DDTAB macro to be a .ADDRESS rather than GENRADDR. ; Remove LMF fields from the DPTAB. Remove unused mount ; verification slots from DDTAB. ; ; X-17 LSS0264 Leonard S. Szubowicz 22-Jan-1993 ; In the DDTAB macro, fix a typo in a reference to DDT$$BASE. ; In DPTAB, DDTAB, and FDT_INI macros declare all the new ; system routine references that were added by X-15 as external ; symbols. This is required if .DISABLE GLOBAL is in effect. ; Also, in DDTAB make STEP=1 the default if no prior or ; current declaration. In DDTAB and DPTAB check to make sure ; that the current step is the same as any prior declaration. ; ; X-16 WDB:HLL022 Walter D. Blaschuk, Jr. 11-Jan-1993 ; HLLDD Project: FDT processing changes. ; Add the Macro-32 macros which will set up the entry ; points to driver specific upper level FDT routines. ; These entry points will be .CALL_ENTRY and move the ; standard inputs into the commonly used registers. ; ; X-15 DEE0171 David E. Eiche 12-Jan-1993 ; Modify DPTAB and DDTAB to add STEP 2 driver dispatch ; fields. Add FDT_INI, FDT_BUF and FDT_ACT macros to ; implement the STEP 2 function decision table format. ; ; X-14 WDB:HLL009 Walter D. Blaschuk, Jr. 11-Jan-1993 ; HLLDD Project: FDT processing changes. ; Add the Macro-32 macros which will set up the calls ; to the FDT completion routines and some FDT support ; routines. ; ; X-13 WDB:HLL008 Walter D. Blaschuk, Jr. 06-Jan-1993 ; HLLDD Project: FDT processing changes. ; Add the $FDTARGDEF macro for the use in Step 2 upper ; level FDT routines for parameter offsets. ; Add FDT2 .long 0 to the DDTTAB macro temporarily. ; ; X-12 LSS0258 Leonard S. Szubowicz 16-Nov-1992 ; Remove usage of EVAX and VAX conditionals in the DPT_STORE ; and DRIVER_CODE macros. ; ; X-11 TYC Theresa Chin 22-Jun-1992 ; Add SP1$ macros to use CALL interface rather than JSB ; to call various SCSI routines. Also use new SCQDEF ; data structure to pass parameters in SP1$CONNECT macro. ; ; X-10 PJH Paul J. Houlihan 08-May-1992 ; Remove obsolete $PRTCT* macros. ; ; X-9 ROW0810 Ralph O. Weber 23-APR-1992 17:54 ; Add a reference to $PDSCDEF in DPT_STORE_ISR. This should ; prevent driver writers from having to make an explicit ; invocation of the $PDSCDEF macro. ; ; ---------- Ident numbering change due to master pack reorg --------- ; ; X-16 LSS0241 Leonard S. Szubowicz 27-Feb-1992 ; In macro DPTAB assure DPT is quadword aligned and in macro ; DDTAB assure DDT is quadword aligned. Also, in macros ; TIMEDWAIT and TIMEDELAY allocate enough stack space to handle ; a less than longword aligned stack. ; ; X-15 ROW0798 Ralph O. Weber 31-DEC-1991 10:49 ; Add BT_ORDER parameter to DPTAB macro and use its value to ; set DPT$IS_BTORDER. The macro compiler no longer crashes ; when presented with the extended DPTAB parameter list. ; This completes the work begun in ROW0788. ; ; X-14 ROW0796 Ralph O. Weber 19-DEC-1991 17:15 ; Add informational message to DPTAB that cautions against ; use of STEP=1 drivers. ; ; X-13 JTK Jim Klumpp 04-Dec-1991 ; Remove the following obsolete macros: ADPDISP, ; BI_NODE_RESET, LOADALT, PURDPR, RELALT, RELDPR, ; RELMP, REQALT, REQDPR, REQMPR. ; ; X-12 ROW0790 Ralph O. Weber 18-NOV-1991 14:33 ; Change SPI$CONNECT to return SS$_NOSUCHDEV in R0 instead of ; bugchecking. This (combined with some already done changes ; in DKDRIVER) will eliminate any boot-time driver loading ; dependencies between DKDRIVER and PK%DRIVER. ; ; X-11 LSS0234 Leonard S. Szubowicz 14-Nov-1991 ; Remove the VAX-specific version of CPUDISP from this source ; file. It was replacing the Alpha-specific version previously ; defined in SYSMAR.MAR. Also remove obsolete CPUDISPATCH and ; SUBCPUDISPATCH macros. ; ; X-10 BJT266 Benjamin J. Thomas III 11-Nov-1991 ; Modify the IOFORK macro to be a consumer of FORK ; ; X-9 ROW0788 Ralph O. Weber 23-OCT-1991 15:08 ; Add DPT$IS_BTORDER to DPTAB macro. Currently, I cannot stick ; in a DPTAB parameter to set the value. The macro compiler ; blows up when I try. ; ; X-8 BJT253 Benjamin J. Thomas III 11-Oct-1991 ; Once again, fix up CRAM_ALLOC order of arguments ; ; X-7 BJT248 Benjamin J. Thomas III 20-Sep-1991 ; Fix up CRAM_ALLOC, arguments are pushed in the wrong order ; ; X-6 ROW0783 Ralph O. Weber 16-SEP-1991 09:00 ; Fix SPI$CONNECT to use PUSHR/POPR instead of PUSHQ/POPQ. ; Gag! How did this bogus tripe last so long? ; ; X-5 BJT238 Benjamin J. Thomas III 04-Sep-1991 ; Add ADP argument to CRAM_ALLOC ; ; X-4 CEG Clair Grant 08-Aug-1991 ; In DRIVER_CODE and DRIVER_DATA, make psects be 32-byte aligned. ; ; X-3 LSS0192 Leonard S. Szubowicz 28-Jun-1991 ; Remove obsolete UNIBUS/MASSBUS map register macros. ; ; X-2 ROW0754 Ralph O. Weber 15-MAY-1991 11:35 ; Add $SVA_TO_PA, system virtual address to physical address ; conversion. Add $SVAPTE_TO_PA, SVAPTE + BOFF to physical ; address conversion. ; ; ---------- Ident numbering change due to move from SYS to LIB --------- ; ; X-7 SCM Steven C. Mayhew 13-Mar-1991 ; removed old SCS macros. The new SCS macros are in the ; cluster facility (SYSAP_MACROS.MAR) and will still be in ; LIB.MLB ; ; X-6 ROW0741 Ralph O. Weber 13-MAR-1991 10:44 ; Add the CHANNEL_ASSIGN and CANCEL_SELECTIVE fields used by ; open VMS to the DDTAB macro initialization of a DDT. Also, ; leave the first longword of the DDT unused and add a ; DDT$IW_SIZE field, as required by the terminal class driver. ; ; X-5 ROW0740 Ralph O. Weber 12-MAR-1991 15:38 ; Add SPI$FINISH_COMMAND so that the macros match the ; documentation. This change matches MCY002 (X-160) in ; the VAX/VMS development streem. ; ; ---------- Ident numbering change due to master pack reorg --------- ; ; X-1K28 JTK Jim Klumpp 05-Mar-1991 ; In TIMEDWAIT macro, perform the approriate LDQ/STQ sequence ; on the NSEC parameter based on its type. ; ; X-1K27 BJT0220 Benjamin J. Thomas III 10-Feb-1991 ; Add RETURN parameter to REQCOM to allow RSB or RET exits ; ; X-1K26 BJT0219 Benjamin J. Thomas III 28-Jan-1991 ; Update REQCOM to be JSB/RSB pair rather than JMP. ; ; X-1K25 ROW0728 Ralph O. Weber 24-JAN-1991 15:58 ; Add a RETURN parameter to the IOFORK macro, like was done to ; the FORK macro in ROW0709. This is necessary to facilitate ; coding of interrupt service routines, which are called via ; a CALL not a JSB. ; ; X-1K24 ROW0723 Ralph O. Weber 21-JAN-1991 17:07 ; Fix the SPI$TQE_WAIT macro so that it can deal with an ; input stack arrangement that is longword but not quadword ; aligned. ; ; X-1K23 ROW0722 Ralph O. Weber 20-JAN-1991 21:09 ; Update the SPI$CONNECT macro to use the newly created system ; cell IOC$GL_SPI_CONNECT instead of EXE$GL_SYS_SPECIFIC. ; ; X-1K22 ROW0720 Ralph O. Weber 16-JAN-1991 15:23 ; Change the TICKS and SECONDS parameters on the SPI$TQE_WAIT ; macro to allow values other than compile time constants. ; Also fix mistake in setting up the parameters to the ; SPDT$PS_TQE_WAIT call. ; ; X-1K19 BJT215 Benjamin J. Thomas III 12-Jan-1991 ; Add CRAM macros: CRAM_ALLOC, CRAM_DEALLOC, CRAM_IO, ; CRAM_QUEUE, CRAM_WAIT and CRAM_CMD ; ; X-1K18 ROW0715 Ralph O. Weber 21-DEC-1990 16:45 ; Add SPI$TQE_WAIT macro. SPI$TQE_WAIT is a SCSI class/port ; interface macro that waits a class driver KP thread for a ; specified number of seconds (or VMS clock ticks). ; ; X-1K17 ROW0714 Ralph O. Weber 07-DEC-1990 11:43 ; Merge late V5.4 change in SPI$MAP_BUFFER into this source. ; Original change was done by Jim Klumpp. It adds apriority ; parameter to the SPI$MAP_BUFFER macro. ; ; X-1K16 BJT213 Benjamin J. Thomas III 5-Dec-1990 ; Sigh. Fix missing .ENDC in TIMEDWAIT ; ; X-1K15 BJT213 Benjamin J. Thomas III 27-Nov-1990 ; Fix omission in TIMEDWAIT argument list. ; ; X-1K14 BJT213 Benjamin J. Thomas III 16-Nov-1990 ; Add new TIMEDWAIT macro. ; Obsolete TIMEWAIT macro. ; Add new TIMEDELAY macro. ; ; X-1K13 ROW0710 Ralph O. Weber 16-NOV-1990 14:29 ; In DPTAB: Add space for loader handle (to permit eventual ; unloading of drivers). Quad align DPT$Q_LINKTIME. ; ; X-1K12 ROW0709 Ralph O. Weber 12-NOV-1990 18:26 ; Add RETURN=RSB parameters to WFIKPCH, WFIRLCH, FORK, and ; FORK_WAIT so that these macros can be used by the kernel ; process services routines (which are call-based). Fix ; REQPCHAN to use IOC$PRIMITIVE_REQCHAN{H/L} instead of ; IOC$PRIMITIVE_REQ*P*CHAN{H/L}. Add KP stack size and ; register save mask parameters to DDTAB. ; ; X-1K11 LSS0184 Leonard S. Szubowicz 7-Nov-1990 ; Change the psect attributes used by the DRIVER_CODE and ; DRIVER_DATA macros such that the psects could be grouped into ; image sections in the manner required for an execlet. ; ; X-1K10 ROW0707 Ralph O. Weber 04-NOV-1990 10:00 ; Enhance the DDTAB macro to generate an entry for the kernel ; process start I/O routine, DDT$PS_KP_STARTIO. When a driver ; uses kernel processes, DDT$PS_START will point to ; EXE$KP_STARTIO (a common routine that gets the start I/O ; kernel process thread started at the address pointed to by ; DDT$PS_KP_STARTIO. ; ; X-1K9 LSS0182 Leonard S. Szubowicz 2-Nov-1990 ; Add optional DPT=EVMS$DRIVER_DPT arg to DPTAB to allow the ; definition of an alternate global symbol for the DPT location. ; Make the DRIVER$$STRUC_INIT and DRIVER$$STRUC_REINIT entry ; point names, which are defined by DPT_STORE INIT and REINIT, ; to be local symbols. The above are required to link MBDRIVER ; and NLDRIVER together into the SYSDEVICE.EXE image. ; Also, remove extra .SAVE_PSECT generated by DPT_STORE INIT, ; and add declaration of linkage psect to DRIVER_CODE macro. ; ; X-1K8 ROW0706 Ralph O. Weber 28-OCT-1990 17:07 ; - Eliminate the generation of a CALL (to the reinit routine) ; by DPT_STORE REINIT. The necessary call is already being ; done by the exec routine that calls init and reinit ; routines. ; - Fix bad DSC symbol references in DPTAB. ; - Change DPT$K_STEP1 to DPT$K_STEP_1 in DPTAB. ; ; X-1K7 ROW0703 Ralph O. Weber 15-OCT-1990 17:27 ; Change DPTAB macro to reference DPT$Q_LINKTIME instead of ; DPT$IQ_LINKTIME. SDL cannot build both symbols in a way ; that makes BLISS happy. So, I had to stop creating the IQ ; tagged symbol. ; ; X-1K6 ROW0701 Ralph O. Weber 10-OCT-1990 16:54 ; Update DPTAB, DPT_STORE, DDTAB, and FUNCTAB to match the ; current design. Also, add DRIVER_CODE and DRIVER_DATA macros. ; ; X-1K5 WCT0209 Ward C. Travis 27-Sep-1990 ; Provide stubbed functions for $PRTCTINI and ; $PRTCTEND until new proposal/design is hammered ; out. ; ; X-1K4 LSS0167 Leonard S. Szubowicz 14-Sep-1990 ; Add new macro FORK_ROUTINE to declare fork routine entry point. ; ; X-1K3 LSS0161 Leonard S. Szubowicz 1-Aug-1990 ; Changes to the FORK, IOFORK, FORK_WAIT, REQPCHAN, WFIKPCH, and ; WFIRLCH macros in support of the "simple fork" mechanism on ; EVAX. Also remove the obsolete REQSCHAN and RELSCHAN macros. ; ;** ; CRAM Macros ; CRAM_ALLOC - Used to allocate a CRAM .MACRO CRAM_ALLOC - CRAM, - ; Address of longword for CRAM address IDB=#0, - ; (Optional) Address of IDB UCB=#0, - ; (Optional) Address of UCB ADP=#0 ; (Optional) Address of ADP CLRL -(SP) ; Clear space for returned address PUSHL ADP ; Pass pointer to ADP PUSHL UCB ; Pass pointer to UCB PUSHL IDB ; Pass pointer to IDB PUSHAB 12(SP) ; Point to CRAM address on stack CALLS #4,G^IOC$ALLOCATE_CRAM ; Allocate a CRAM POPL CRAM ; Retrieve the CRAM address .ENDM CRAM_ALLOC ; CRAM_DEALLOC - Deallocate a CRAM .MACRO CRAM_DEALLOC - CRAM ; Address of CRAM PUSHL CRAM ; Point to the CRAM CALLS #1,G^IOC$DEALLOCATE_CRAM; Deallocate it .ENDM CRAM_DEALLOC ; CRAM_IO - Perform I/O operation with a CRAM .MACRO CRAM_IO - CRAM ; Address of CRAM PUSHL CRAM ; Point to the CRAM CALLS #1,G^IOC$CRAM_IO ; Perform the operation .ENDM CRAM_IO ; CRAM_QUEUE - Queue an I/O operation with the CRAM .MACRO CRAM_QUEUE - CRAM ; Address of the CRAM PUSHL CRAM ; Point to the CRAM CALLS #1,G^IOC$CRAM_QUEUE ; Queue it .ENDM CRAM_QUEUE ; CRAM_WAIT - Wait for I/O operation to be finished .MACRO CRAM_WAIT - CRAM ; Address of the CRAM PUSHL CRAM ; Point to the CRAM CALLS #1,G^IOC$CRAM_WAIT ; Wait for the operation to complete .ENDM CRAM_WAIT ; CRAM_CMD - Obtain bus and operation specific COMMAND, MASK and RBADR fields .MACRO CRAM_CMD - INDEX, - ; Command index OFFSET, - ; Offset from base CSR address ADP, - ; Pointer to ADP CRAM=#0,- ; (Optional) Address of CRAM COMMAND=#0 ; (Optional) Address of octaword buffer PUSHL COMMAND ; Point to COMMAND field PUSHL CRAM ; Point to the CRAM PUSHL ADP ; Point to the ADP PUSHL OFFSET ; Save the offset PUSHL INDEX ; Save the INDEX CALLS #5,G^IOC$CRAM_CMD ; Get the command .ENDM CRAM_CMD ; ; ; ; GENERATE DRIVER DISPATCH TABLE ; ; DDTAB -- A ton of parameters, see the macro definition below. ; ; .MACRO DDTAB DEVNAM,- ; device name for symbol START=0,- ; start I/O routine CTRLINIT=0,- ; controller init routine FUNCTB,- ; FDT address CANCEL=0,- ; cancel I/O routine REGDMP=0,- ; register dump routine DIAGBF=0,- ; diagnostic buffer size ERLGBF=0,- ; error log buffer size UNITINIT=0,- ; unit init routine ALTSTART=0,- ; alt start I/O routine MNTVER=0,- ; mount verification routine CLONEDUCB=0,- ; cloned UCB routine MNTV_SSSC=0,- ; mount ver rout. for shadow sets MNTV_FOR=0,- ; mount ver rout. for /FOREIGN MNTV_SQD=0,- ; mount ver rout. for tapes CHANNEL_ASSIGN=0,- ; routine to call from $ASSIGN CANCEL_SELECTIVE=0,- ; selective cancel routine KP_STACK_SIZE=0,- ; KP stack byte count KP_REG_MASK=0,- ; KP register save mask KP_STARTIO=0,- ; start I/O for KP drivers CSR_MAPPING=0,- ; CSR mapping routine AUX_STORAGE=0,- AUX_ROUTINE=0,- STEP,- JSB_START,- ; start I/O jsb (step 2) JSB_ALTSTART,- ; alt start I/O jsb (step 2) FAST_FDT,- ; Fast-IO FDT routine (post step 2) PENDING_IO=0 ; Pending I/O routine $DDTDEF $FDTDEF .IF NOT_BLANK,STEP ;if STEP= explicitly specified .IF DIFFERENT ,<2> ; assure that value is 2 .ERROR ;DDTAB must declare driver %extract(0,4,)=2 ; .ENDC .IF DEFINED,$$STEP ;if previously specified .IF NOT_EQUAL,$$STEP-STEP ; assure this is same value .ERROR $$STEP ;DDTAB %extract(0,4,)=STEP conflicts with prior declaration; .ENDC .ENDC $$STEP = STEP .ENDC .IF NOT_DEFINED,$$STEP $$STEP = 2 .PRINT $$STEP ;DDTAB is assuming driver %extract(0,4,)=2; .ENDC .IF IDENTICAL , .ERROR ;%extract(0,5,)=EXE$KP_STARTIO isn't valid for %extract(0,4,)=2. Try EXE_STD$KP_STARTIO ; .ENDC .IF IDENTICAL , .ERROR ;%extract(0,6,)=IOC$CANCELIO isn't valid for %extract(0,4,)=2. Try IOC_STD$CANCELIO ; .ENDC .IF IDENTICAL , .ERROR ;%extract(0,6,)=IOC$MNTVER isn't valid for %extract(0,4,)=2. Try IOC_STD$MNTVER ; .ENDC .IF NOT_BLANK,JSB_START .IF DIFFERENT,START,0 .IF DIFFERENT,START,IOC$START_C2J .WARN ;%extract(0,5,)=START superseded by %extract(0,9,)=JSB_START; .ENDC .ENDC .ENDC .IF NOT_BLANK,JSB_ALTSTART .IF DIFFERENT,ALTSTART,0 .IF DIFFERENT,ALTSTART,IOC$ALTSTART_C2J .WARN ;%extract(0,8,)=ALTSTART superseded by %extract(0,12,)=JSB_ALTSTART; .ENDC .ENDC .ENDC DRIVER_DATA .ALIGN QUAD 'DEVNAM'$DDT:: DDT$$BASE: .LONG 0 ; reserved .LONG 0 ; reserved ASSUME DDT$IW_SIZE EQ <.-DDT$$BASE> .WORD DDT$K_LENGTH .WORD 0 ASSUME DDT$IW_DIAGBUF EQ <.-DDT$$BASE> .WORD DIAGBF ASSUME DDT$IW_ERRORBUF EQ <.-DDT$$BASE> .WORD ERLGBF ASSUME DDT$IW_FDTSIZE EQ <.-DDT$$BASE> .WORD FDT$K_LENGTH .WORD 0 .IF BLANK,JSB_START .GLOBAL IOC$RETURN_SUCCESS ASSUME DDT$PS_START_2 EQ <.-DDT$$BASE> GENRADDR START,IOC$RETURN_SUCCESS ASSUME DDT$PS_START_JSB EQ <.-DDT$$BASE> .LONG 0 .IFF $$JSB_START = 1 .GLOBAL IOC$RETURN,IOC$START_C2J ASSUME DDT$PS_START_2 EQ <.-DDT$$BASE> GENRADDR IOC$START_C2J ASSUME DDT$PS_START_JSB EQ <.-DDT$$BASE> GENRADDR JSB_START,IOC$RETURN .ENDC ASSUME DDT$PS_CTRLINIT_2 EQ <.-DDT$$BASE> .GLOBAL IOC$RETURN_SUCCESS GENRADDR CTRLINIT,IOC$RETURN_SUCCESS ASSUME DDT$PS_UNITINIT_2 EQ <.-DDT$$BASE> .GLOBAL IOC$RETURN_SUCCESS GENRADDR UNITINIT,IOC$RETURN_SUCCESS ASSUME DDT$PS_CLONEDUCB_2 EQ <.-DDT$$BASE> .GLOBAL IOC$RETURN_SUCCESS GENRADDR CLONEDUCB,IOC$RETURN_SUCCESS ASSUME DDT$PS_FDT_2 EQ <.-DDT$$BASE> .ADDRESS FUNCTB ASSUME DDT$PS_CANCEL_2 EQ <.-DDT$$BASE> .GLOBAL IOC$RETURN_SUCCESS GENRADDR CANCEL,IOC$RETURN_SUCCESS ASSUME DDT$PS_REGDUMP_2 EQ <.-DDT$$BASE> .GLOBAL IOC$RETURN_SUCCESS GENRADDR REGDMP,IOC$RETURN_SUCCESS .IF BLANK,JSB_ALTSTART .GLOBAL IOC$RETURN_SUCCESS ASSUME DDT$PS_ALTSTART_2 EQ <.-DDT$$BASE> GENRADDR ALTSTART,IOC$RETURN_SUCCESS ASSUME DDT$PS_ALTSTART_JSB EQ <.-DDT$$BASE> .LONG 0 .IFF $$JSB_ALTSTART = 1 .GLOBAL IOC$RETURN,IOC$ALTSTART_C2J ASSUME DDT$PS_ALTSTART_2 EQ <.-DDT$$BASE> GENRADDR IOC$ALTSTART_C2J ASSUME DDT$PS_ALTSTART_JSB EQ <.-DDT$$BASE> GENRADDR JSB_ALTSTART,IOC$RETURN .ENDC ASSUME DDT$PS_MNTVER_2 EQ <.-DDT$$BASE> .GLOBAL IOC_STD$MNTVER GENRADDR MNTVER,IOC_STD$MNTVER ASSUME DDT$PS_MNTV_SSSC EQ <.-DDT$$BASE> GENRADDR MNTV_SSSC ASSUME DDT$PS_MNTV_FOR EQ <.-DDT$$BASE> GENRADDR MNTV_FOR ASSUME DDT$PS_MNTV_SQD EQ <.-DDT$$BASE> GENRADDR MNTV_SQD ASSUME DDT$PS_AUX_STORAGE EQ <.-DDT$$BASE> GENRADDR AUX_STORAGE ASSUME DDT$PS_AUX_ROUTINE EQ <.-DDT$$BASE> GENRADDR AUX_ROUTINE ASSUME DDT$PS_CHANNEL_ASSIGN_2 EQ <.-DDT$$BASE> .GLOBAL IOC$RETURN_UNSUPPORTED GENRADDR CHANNEL_ASSIGN,IOC$RETURN_UNSUPPORTED ASSUME DDT$PS_CANCEL_SELECTIVE_2 EQ <.-DDT$$BASE> .GLOBAL IOC$RETURN_UNSUPPORTED GENRADDR CANCEL_SELECTIVE,IOC$RETURN_UNSUPPORTED ASSUME DDT$IS_STACK_BCNT EQ <.-DDT$$BASE> .LONG KP_STACK_SIZE ASSUME DDT$IS_REG_MASK EQ <.-DDT$$BASE> .LONG KP_REG_MASK ASSUME DDT$PS_KP_STARTIO EQ <.-DDT$$BASE> GENRADDR KP_STARTIO ASSUME DDT$PS_CSR_MAPPING EQ <.-DDT$$BASE> .GLOBAL IOC$RETURN_SUCCESS GENRADDR CSR_MAPPING,IOC$RETURN_SUCCESS ASSUME DDT$PS_FAST_FDT EQ <.-DDT$$BASE> .IF BLANK,FAST_FDT .LONG 0 .IFF GENRADDR FAST_FDT .ENDC ASSUME DDT$PS_PENDING_IO EQ <.-DDT$$BASE> .GLOBAL EXE_STD$INSERT_IRP GENRADDR PENDING_IO,EXE_STD$INSERT_IRP ASSUME DDT$PS_CUSTOMER EQ <.-DDT$$BASE> .ADDRESS 0 ASSUME DDT$C_LENGTH EQ <.-DDT$$BASE> .ENDM DDTAB ; ; DEVICE DRIVER PROLOGUE TABLE ; ; DPTAB -- parameters for days, see macro definition below. ; .MACRO DPTAB END, - ; not used in EVMS ADAPTER, - ; Adapter type FLAGS=0, - ; DPT flags UCBSIZE, - ; size of UCB UNLOAD=0, - ; unload routine MAXUNITS=8, - ; max units to configure DEFUNITS=1, - ; default units to configure DELIVER=0, - ; unit delivery routine VECTOR=0, - ; driver-spec address NAME, - ; driver name SMP=NO, - ; not used in EVMS DECODE=0, - ; DECwindows-spec address STEP=0, - ; EVMS driver step number IDB_CRAMS=0, - ; CRAMs allocated on IDB UCB_CRAMS=0, - ; CRAMs allocated on each UCB BT_ORDER=0, - ; Boot-time init ordering control IOHANDLES=0, - ; IOHANDLES needed by driver DDT=DDT$$BASE, - STRUC_INIT=DRIVER$STRUC_INIT, - STRUC_REINIT=DRIVER$STRUC_REINIT, - PSECT=$$$105_PROLOGUE,- DPT=DRIVER$DPT .IF DIFFERENT,,<2> .ERROR 0 ;DPTAB must declare driver %extract(0,4,)=2 ; .ENDC .IF DEFINED,$$STEP ;if previously specified .IF NOT_EQUAL,$$STEP-STEP ; assure this is same value .ERROR $$STEP ;DPTAB %extract(0,4,)=STEP conflicts with prior declaration; .ENDC .ENDC $$STEP = $DPTDEF $SPLCODDEF $DSCDEF $NAMDEF .SAVE DRIVER_DATA PSECT .ALIGN QUAD 'DPT':: ASSUME DPT$PS_FLINK EQ 0 ASSUME DPT$PS_BLINK EQ 4 .LONG 0, 0 ASSUME DPT$IW_SIZE EQ <.-DPT> .WORD DPT$K_BASE_LEN+NAM$C_MAXRSS ASSUME DPT$IB_TYPE EQ <.-DPT> .BYTE DYN$C_DPT .BYTE 0 ASSUME DPT$IW_STEP EQ <.-DPT> .WORD DPT$K_STEP_'STEP' ASSUME DPT$IW_STEPVER EQ <.-DPT> .IF EQUAL,$$STEP - 2 .WORD DPT$K_STEP2_V5 .IFF .WORD DPT$K_STEP1_V2 .ENDC ASSUME DPT$IW_DEFUNITS EQ <.-DPT> .WORD DEFUNITS ASSUME DPT$IW_MAXUNITS EQ <.-DPT> .WORD MAXUNITS ASSUME DPT$IW_UCBSIZE EQ <.-DPT> .WORD UCBSIZE ASSUME DPT$IW_IOHANDLES EQ <.-DPT> .WORD IOHANDLES ASSUME DPT$IW_IDB_CRAMS EQ <.-DPT> .WORD IDB_CRAMS ASSUME DPT$IW_UCB_CRAMS EQ <.-DPT> .WORD UCB_CRAMS ASSUME DPT$IL_FLAGS EQ <.-DPT> .IIF IDN ,, ..SMP_FLAG.. = DPT$M_SMPMOD .LONG FLAGS!..SMP_FLAG.. ASSUME DPT$IL_ADPTYPE EQ <.-DPT> .LONG AT$_'ADAPTER' ASSUME DPT$IL_REFC EQ <.-DPT> .LONG 0 ASSUME DPT$PS_INIT_PD EQ <.-DPT> .ADDRESS STRUC_INIT ASSUME DPT$PS_REINIT_PD EQ <.-DPT> .ADDRESS STRUC_REINIT ASSUME DPT$PS_DELIVER_2 EQ <.-DPT> .ADDRESS DELIVER ASSUME DPT$PS_UNLOAD EQ <.-DPT> .ADDRESS UNLOAD ASSUME DPT$PS_DDT EQ <.-DPT> .ADDRESS DDT ASSUME DPT$PS_DDB_LIST EQ <.-DPT> .LONG 0 ASSUME DPT$IS_BTORDER EQ <.-DPT> .LONG BT_ORDER ASSUME DPT$PS_VECTOR EQ <.-DPT> .ADDRESS VECTOR ASSUME DPT$T_NAME EQ <.-DPT> $$$=. .ASCIC /NAME/ .=$$$+DPT$S_NAME ASSUME DPT$IL_ECOLEVEL EQ <.-DPT> .LONG 0 ASSUME DPT$L_UCODE EQ <.-DPT> .LONG 0 ASSUME DPT$Q_LINKTIME EQ <.-DPT> .QUAD 0 ASSUME DPT$IW_INAME_LEN EQ <.-DPT> .WORD NAM$C_MAXRSS ASSUME DPT$IB_INAME_TYPE EQ <.-DPT> .BYTE DSC$K_DTYPE_T ASSUME DPT$IB_INAME_CLASS EQ <.-DPT> .BYTE DSC$K_CLASS_S ASSUME DPT$PS_INAME_PTR EQ <.-DPT> .ADDRESS DPT+DPT$T_IMAGE_NAME ASSUME DPT$IL_LOADER_HANDLE EQ <.-DPT> ASSUME DPT$S_LOADER_HANDLE EQ 16 .LONG 0,0,0,0 ASSUME DPT$L_DECW_SNAME EQ <.-DPT> .ADDRESS DECODE ASSUME DPT$PS_CUSTOMER EQ <.-DPT> .LONG 0 ASSUME DPT$K_BASE_LEN EQ <.-DPT> ASSUME DPT$T_IMAGE_NAME EQ <.-DPT> .BLKB NAM$C_MAXRSS .IIF NDF ..SMP_FLAG.., ..SMP_FLAG.. = 0 .MDELETE DPTAB .ENDM DPTAB ; ; STORE DPT INITIALIZATION ROUTINE GENERATOR ; ; DPT_STORE STRUC_TYPE,STRUC_OFFSET,OPERATION,EXPRESSION,POS,SIZE ; ; STRUC_TYPE = STRUC TYPE CODE (DDB,UCB,CRB,IDB) ; = "INIT" IF START OF INIT TABLE ; = "REINIT" IF START OF RE-INIT TABLE ; = "END" IF END OF RE-INIT TABLE ; STRUC_OFFSET = UNSIGNED OFFSET INTO STRUC ; OPERATION = TYPE OF INITIALIZATION OPERATION ; B=BYTE,W=WORD,L=LONG,D=RELATIVE TO DRIVER,V=FIELD ; IF PRECEDED BY "@" (IE. @B) THEN EXPRESSION ; IS ADDRESS OF DATA ; EXPRESSION = EXPRESSION TO BE STORED ; POS = BIT POSITION (FOR OPERATION = V ONLY) ; SIZE = FIELD SIZE (FOR OPERATION = V ONLY) ; .MACRO DPT_STORE STR_TYPE,STR_OFF,OPER,EXP,POS,SIZE, - crb=4,ddb=8,idb=12,orb=16,ucb=20, - letters$$=< #L W B AB(r2)(r3)(r4)(r5)(r6)> .IF IDN , op$$=0 lit$$=0 reg$$=0 DRIVER_CODE DRIVER$STRUC_INIT: .CALL_ENTRY PRESERVE= MOVL crb(ap),r2 MOVL ddb(ap),r3 MOVL idb(ap),r4 MOVL orb(ap),r5 MOVL ucb(ap),r6 .IFF .IF IDN , RET DRIVER$STRUC_REINIT: .CALL_ENTRY PRESERVE= MOVL crb(ap),r2 MOVL ddb(ap),r3 MOVL idb(ap),r4 MOVL orb(ap),r5 MOVL ucb(ap),r6 .IFF .IF IDN , RET .RESTORE .IFF crb$$=10 ddb$$=14 idb$$=18 orb$$=22 ucb$$=26 reg$$='str_type'$$ op$$=2 lit$$=1 .IRPC C, .IIF IDN ,<@>, lit$$=0 .IIF IDN ,, op$$=2 .IIF IDN ,, op$$=4 .IIF IDN ,, op$$=6 .IIF IDN ,, op$$=-1 .IIF IDN ,, op$$=8 .IIF IDN ,, lit$$=0 .ENDR .IF LT op$$ INSV %extract(lit$$,1,letters$$)<'exp'>, - #pos, #size, 'str_off'%extract(reg$$,4,letters$$) .IFF MOV%extract(op$$,2,letters$$) %extract(lit$$,1,letters$$)<'exp'>, - 'str_off'%extract(reg$$,4,letters$$) .ENDC .ENDC .ENDC .ENDC .ENDM DPT_STORE ; ; Store ISR procedure descriptor and entry point address in ; ; ; DPT_STORE_ISR VEC_OFF,ENTRY ; ; VEC_OFF - CRB Interrupt transfer vector ; ENTRY - Address (label) of .call_entry for ISR ; (procedure descriptor) ; ; .MACRO DPT_STORE_ISR VEC_OFF,ENTRY $PDSCDEF MOVAL 'entry',R0 MOVL R0,<<'vec_off'>+VEC$PS_ISR_PD>(R2) MOVL PDSC$Q_ENTRY(R0),<<'vec_off'>+VEC$PS_ISR_CODE>(R2) .ENDM DPT_STORE_ISR ;++ ; Setup platform-specific DIPL value in the device UCB. ; This macro is valid only in the contex of a DPT_STORE INIT or REINIT section. ; ; DPT_STORE_DIPL ;-- .MACRO DPT_STORE_DIPL PUSHL R6 ;param1 = UCB address CALLS #1,IOC$SETUP_UCB_DIPL .ENDM DPT_STORE_DIPL ;++ ; Setup a device driver code PSECT ; ; DRIVER_CODE [PSECT-Name] ; ; PSECT-Name - Optional name of driver code PSECT. The default is ; $$$115_DRIVER. ;-- .MACRO DRIVER_CODE - PNAME=$$$115_DRIVER,LNAME=$$$115_LINKAGE .PSECT LNAME,5,PIC,CON,REL,LCL,NOSHR,NOEXE,RD,WRT .LINKAGE_PSECT LNAME .PSECT 'PNAME',5,NOWRT,EXE,PIC .ENDM DRIVER_CODE ;++ ; Setup a device driver data PSECT ; ; DRIVER_DATA [PSECT-Name] ; ; PSECT-Name - Optional name of driver data PSECT. The default is ; $$$110_DATA. ;-- .MACRO DRIVER_DATA - PNAME=$$$110_DATA .PSECT 'PNAME',5,WRT,NOEXE,PIC .ENDM DRIVER_DATA ;++ ; Provides standard .CALL_ENTRY and standard AP offsets for the four parameters ; of all Step 2 upper level FDT routines. These offsets are used to move input ; parameters from their offsets from the AP to the commonly used register. ; The default preserve registers are R2-R11. FETCH=YES is the default and will ; cause the macro to move the AP inputs to the commonly used registers. If ; FETCH=NO then the inputs will not be moved. ; This macro is intended for the use by private driver specific upper level FDT ; routines. ; ; your_upper_level_fdt_routine_name: ; $DRIVER_FDT_ENTRY PRESERVE=, FETCH=YES ; ;-- .MACRO $DRIVER_FDT_ENTRY - PRESERVE=, - FETCH=YES $FDTARGDEF $$$USE_PRESERVE = 1 .IIF IDENTICAL,,, $$$USE_PRESERVE = 0 .IIF IDENTICAL,,, $$$USE_PRESERVE = 0 .IF EQ,$$$USE_PRESERVE-1 .CALL_ENTRY %EXTRACT(0,8,) = .IF_FALSE .CALL_ENTRY .ENDC .IF DIFFERENT,FETCH,NO ; Validate FETCH keyword. .IF DIFFERENT,FETCH,YES ; If not 'NO' and not 'YES' give error. .ERROR 0 ;Keyword %EXTRACT(0,5,) must be either YES or NO; .ENDC .ENDC .IF IDENTICAL,FETCH,YES MOVL FDTARG$_IRP(AP),R3 MOVL FDTARG$_PCB(AP),R4 MOVL FDTARG$_UCB(AP),R5 MOVL FDTARG$_CCB(AP),R6 .ENDC .ENDM $DRIVER_FDT_ENTRY ;++ ; Provides standard AP offsets for the four parameters of all Step 2 upper ; level FDT routines. These offsets are used to move input parameters from their ; offsets from the AP to a register. ; ; $FDTARGDEF ; ;-- .MACRO $FDTARGDEF $OFFDEF FDTARG, .ENDM $FDTARGDEF ;++ ; ; CREATE FORK PROCESS ; ; FORK ROUTINE=fork_routine,CONTINUE=label,RETURN=rsb,ENVIRONMENT=JSB|CALL ; ; ROUTINE - is an optional parameter that specifies the name of the fork ; routine. If not specified it is assumed that the fork routine ; immediately follows the FORK macro. ; CONTINUE- is an optional parameter that specifies the label where ; execution continues after the fork routine has been queued. ; If not specified, control returns to the caller of the routine ; that invoked the FORK macro. ; RETURN - "Caller's caller" return semantic (RSB - default, or RET) ; ENVIRONMENT - is an optional keyword that specifies the fork routine ; environment as either JSB or CALL. The default is JSB. ; If specified as JSB, then EXE$PRIMITIVE_FORK is called and ; a .JSB_ENTRY directive is used to generate the fork routine. ; If specified as CALL, then EXE_STD$PRIMITIVE_FORK is called, ; the RETURN parameter is ignored and assumed to be RET, a ; .CALL_ENTRY directive is used to generate the fork routine, ; the FR3, FR4, and FKB parameters in the fork routine are ; copied into R3, R4, and R5. ; ; IMPLICIT INPUTS: ; ; R3 - Arbitrary 64-bit input value for fork routine ; R4 - Arbitrary 64-bit input value for fork routine ; R5 - FKB ; ; IMPLICIT OUTPUTS: ; ; ENVIRONMENT=CALL ; R0,R1 - Scratched. ; ; ENVIRONMENT=JSB ; R3,R4 - Outputs of EXE$PRIMITIVE_FORK. ; ;-- .MACRO FORK ROUTINE,CONTINUE,RETURN=RSB,ENVIRONMENT=JSB,?L1 $FKBDEF .IF DIFFERENT,ENVIRONMENT,JSB ;validate environment keyword .IF DIFFERENT,ENVIRONMENT,CALL .ERROR 0 ;Keyword %EXTRACT(0,11,) must be either CALL or JSB; .ENDC .ENDC .IF BLANK, MOVAB L1,FKB$L_FPC(R5) .IF_FALSE MOVAB ROUTINE,FKB$L_FPC(R5) .ENDC .IF IDENTICAL,ENVIRONMENT,CALL .GLOBAL EXE_STD$PRIMITIVE_FORK EVAX_OR R31,R3,R16 ;R16 (P1) = full 64-bits of R3 EVAX_OR R31,R4,R17 ;R17 (P2) = full 64-bits of R4 PUSHL R5 ;P3 = FKB PUSHL R17 ;P2 = full 64-bits of R4 PUSHL R16 ;P1 = full 64-bits of R3 CALLS #3,EXE_STD$PRIMITIVE_FORK .IF BLANK, RET .IF_FALSE BRW CONTINUE .ENDC .IF BLANK, L1: .CALL_ENTRY INPUT=,PRESERVE= $OFFDEF FORKARG, ASSUME FORKARG$_FR3 EQ <1*4> ASSUME FORKARG$_FR4 EQ <2*4> EVAX_OR R31,R16,R3 ;R3 = full 64-bits of FORKARG$_FR3 EVAX_OR R31,R17,R4 ;R4 = full 64-bits of FORKARG$_FR4 MOVL FORKARG$_FKB(AP),R5 ;R5 = FKB .ENDC .IF_FALSE ;IDENTICAL,ENVIRONMENT,CALL .GLOBAL EXE$PRIMITIVE_FORK .SET_REGISTERS - READ = ,- WRITTEN = JSB G^EXE$PRIMITIVE_FORK .IF BLANK, RETURN .IF_FALSE BRW CONTINUE .ENDC .IF BLANK, L1: .JSB_ENTRY INPUT=,SCRATCH= .ENDC .ENDC ;IDENTICAL,ENVIRONMENT,CALL .ENDM FORK ;++ ; ; FORK ROUTINE ENTRY POINT DECLARATION ; ; FORK_ROUTINE NAME=fork_routine_name, SYMBOL=LOCAL|GLOBAL, ; ENVIRONMENT=JSB|CALL,FETCH=YES|NO ; ; NAME - is an optional parameter that specifies the name of the fork ; routine. ; SYMBOL - is an optional keyword that specifies if the routine name ; should be declared as a local or global symbol. The default ; is for a local symbol. ; ENVIRONMENT - is an optional keyword that specifies the fork routine ; environment as either JSB or CALL. If specified as JSB, ; then a .JSB_ENTRY directive is used to for the fork routine. ; If specified as CALL, then a .CALL_ENTRY directive is used to ; for the fork routine. The default is JSB. ; FETCH - is an optional YES/NO parameter that specifies if the fork ; routine parameters for an ENVIRONMENT=CALL fork routine ; should be copied into the traditional R3. R4. and R5 registers. ; The default is YES. ; ;-- .MACRO FORK_ROUTINE NAME,SYMBOL=LOCAL,ENVIRONMENT=JSB,FETCH=YES .IF DIFFERENT,SYMBOL,GLOBAL ;validate SYMBOL keyword .IF DIFFERENT,SYMBOL,LOCAL .ERROR 0 ;Keyword %EXTRACT(0,6,) must be either LOCAL or GLOBAL; .ENDC .ENDC .IF DIFFERENT,ENVIRONMENT,JSB ;validate ENVIRONMENT keyword .IF DIFFERENT,ENVIRONMENT,CALL .ERROR 0 ;Keyword %EXTRACT(0,11,) must be either CALL or JSB; .ENDC .ENDC .IF DIFFERENT,FETCH,YES ;validate FETCH keyword .IF DIFFERENT,FETCH,NO .ERROR 0 ;Keyword %EXTRACT(0,5,) must either be YES or NO; .ENDC .ENDC .IF NOT_BLANK, ;define routine name .IF IDENTICAL,SYMBOL,GLOBAL NAME:: .IF_FALSE NAME: .ENDC .ENDC .IF IDENTICAL,ENVIRONMENT,CALL ;declare CALL entry point .CALL_ENTRY INPUT= $OFFDEF FORKARG, ;define parameter offsets .IF IDENTICAL,FETCH,YES ASSUME FORKARG$_FR3 EQ <1*4> EVAX_OR R31,R16,R3 ;R3 = full 64-bits of P1 (R16) ASSUME FORKARG$_FR4 EQ <2*4> EVAX_OR R31,R17,R4 ;R4 = full 64-bits of P2 (R17) MOVL FORKARG$_FKB(AP),R5 ;R5 = FKB .ENDC .IF_FALSE ;IDENTICAL,ENVIRONMENT,CALL ;declare JSB entry point .JSB_ENTRY INPUT=,SCRATCH= .ENDC ;IDENTICAL,ENVIRONMENT,CALL .ENDM FORK_ROUTINE ;++ ; ; FORK AND WAIT (for from 0 to 1 seconds) ; ; FORK_WAIT ROUTINE=fork_routine,CONTINUE=label,RETURN=rsb,ENVIRONMENT=JSB|CALL ; ; ROUTINE - is an optional parameter that specifies the name of the fork ; routine. If not specified it is assumed that the fork routine ; immediately follows the FORK_WAIT macro. ; CONTINUE- is an optional parameter that specifies the label where ; execution continues after the fork routine has been queued. ; If not specified, control returns to the caller of the routine ; that invoked the FORK_WAIT macro. ; RETURN - "Caller's caller" return semantic (RSB - default, or RET) ; ENVIRONMENT - is an optional keyword that specifies the fork routine ; environment as either JSB or CALL. The default is JSB. ; If specified as JSB, then EXE$PRIMITIVE_FORK_WAIT is called ; and a .JSB_ENTRY directive is used to generate the fork ; routine. ; If specified as CALL, then EXE_STD$PRIMITIVE_FORK_WAIT is ; called, the RETURN parameter is ignored and assumed to be RET, ; a .CALL_ENTRY directive is used to generate the fork routine, ; the FR3, FR4, and FKB parameters in the fork routine are ; copied into R3, R4, and R5. ; ; IMPLICIT INPUTS: ; ; R3 - Arbitrary 64-bit input value for fork routine ; R4 - Arbitrary 64-bit input value for fork routine ; R5 - FKB ; ; IMPLICIT OUTPUTS: ; ; ENVIRONMENT=CALL ; R0,R1 - Scratched. ; ; ENVIRONMENT=JSB ; - All register preserved, including R0,R1 ; ;-- .MACRO FORK_WAIT ROUTINE,CONTINUE,RETURN=RSB,ENVIRONMENT=JSB,?L1 $FKBDEF .IF DIFFERENT,ENVIRONMENT,JSB ;validate environment keyword .IF DIFFERENT,ENVIRONMENT,CALL .ERROR 0 ;Keyword %EXTRACT(0,11,) must be either CALL or JSB; .ENDC .ENDC .IF BLANK, MOVAB L1,FKB$L_FPC(R5) .IF_FALSE MOVAB ROUTINE,FKB$L_FPC(R5) .ENDC .IF IDENTICAL,ENVIRONMENT,CALL .GLOBAL EXE_STD$PRIMITIVE_FORK_WAIT EVAX_OR R31,R3,R16 ;R16 (P1) = full 64-bits of R3 EVAX_OR R31,R4,R17 ;R17 (P2) = full 64-bits of R4 PUSHL R5 ;P3 = FKB PUSHL R17 ;P2 = full 64-bits of R4 PUSHL R16 ;P1 = full 64-bits of R3 CALLS #3,EXE_STD$PRIMITIVE_FORK_WAIT .IF BLANK, RET .IF_FALSE BRW CONTINUE .ENDC .IF BLANK, L1: .CALL_ENTRY INPUT=,PRESERVE= $OFFDEF FORKARG, ASSUME FORKARG$_FR3 EQ <1*4> ASSUME FORKARG$_FR4 EQ <2*4> EVAX_OR R31,R16,R3 ;R3 = full 64-bits of FORKARG$_FR3 EVAX_OR R31,R17,R4 ;R4 = full 64-bits of FORKARG$_FR4 MOVL FORKARG$_FKB(AP),R5 ;R5 = FKB .ENDC .IF_FALSE ;IDENTICAL,ENVIRONMENT,CALL .GLOBAL EXE$PRIMITIVE_FORK_WAIT .SET_REGISTERS - READ = JSB G^EXE$PRIMITIVE_FORK_WAIT .IF BLANK, RETURN .IF_FALSE BRW CONTINUE .ENDC .IF BLANK, L1: .JSB_ENTRY INPUT=,SCRATCH= .ENDC .ENDC ;IDENTICAL,ENVIRONMENT,CALL .ENDM FORK_WAIT ;++ ; ; CREATE I/O DRIVER FORK PROCESS ; ; IOFORK is very similar to FORK with the following differences: (1) The fork ; block address in R5 is assumed to be a UCB; (2) The UCB$M_TIM bit is cleared; ; (3) ordinary FORK is invoked. ; ; IOFORK ROUTINE=fork_routine,CONTINUE=label,RETURN=rsb,ENVIRONMENT=JSB|CALL ; ; ROUTINE - is an optional parameter that specifies the name of the fork ; routine. If not specified it is assumed that the fork routine ; immediately follows the IOFORK macro. ; CONTINUE- is an optional parameter that specifies the label where ; execution continues after the fork routine has been queued. ; If not specified, control returns to the caller of the routine ; that invoked the IOFORK macro. ; RETURN - "Caller's caller" return semantic (RSB - default, or RET) ; ENVIRONMENT - is an optional keyword that specifies the fork routine ; environment as either JSB or CALL. The default is JSB. ; If specified as JSB, then EXE$PRIMITIVE_FORK is called and ; a .JSB_ENTRY directive is used to generate the fork routine. ; If specified as CALL, then EXE_STD$PRIMITIVE_FORK is called, ; the RETURN parameter is ignored and assumed to be RET, a ; .CALL_ENTRY directive is used to generate the fork routine, ; the FR3, FR4, and FKB parameters in the fork routine are ; copied into R3, R4, and R5. ; ; IMPLICIT INPUTS: ; ; R3 - Arbitrary 64-bit input value for fork routine ; R4 - Arbitrary 64-bit input value for fork routine ; R5 - UCB ; ; IMPLICIT OUTPUTS: ; ; ENVIRONMENT=CALL ; R0,R1 - Scratched. ; ; ENVIRONMENT=JSB ; R3,R4 - Outputs of EXE$PRIMITIVE_FORK. ; ;-- .MACRO IOFORK ROUTINE,CONTINUE,RETURN=RSB,ENVIRONMENT=JSB $FKBDEF ; Define fork block symbols $UCBDEF ; Define UCB symbols ASSUME UCB$Q_FR3 EQ FKB$Q_FR3 ASSUME UCB$Q_FR4 EQ FKB$Q_FR4 ASSUME UCB$L_FPC EQ FKB$L_FPC ; Disable timeouts in the UCB and fork normally BICL #UCB$M_TIM,UCB$L_STS(R5) FORK ROUTINE,CONTINUE,RETURN,ENVIRONMENT .ENDM IOFORK ; ; Function Decision Table Macro Definitions ; These definitions implement the STEP 2 FDT format. ; ; The FDT_INI macro clears the buffered function mask ; to zero and points each slot in the action vector at ; EXE$ILLIOFUNC. ; .MACRO FDT_INI FDT=DRIVER$FDT $FDTDEF DRIVER_DATA $$DEFH = 0 $$DEFL = 0 .ALIGN QUAD FDT$$START = . 'FDT':: ASSUME FDT$Q_BUFFERED EQ .-FDT$$START .LONG 0,0 ASSUME FDT$PS_FUNC_RTN EQ .-FDT$$START .GLOBAL EXE$ILLIOFUNC .REPEAT - 1 @ IO$S_FCODE .ADDRESS - EXE$ILLIOFUNC .ENDR ASSUME FDT$Q_OK64BIT EQ .-FDT$$START .LONG 0,0 ASSUME FDT$K_LENGTH EQ .-FDT$$START .ENDM FDT_INI ; ; The FDT_BUF macro builds the buffered function mask ; from the function codes values passed in the CODES ; parameter. Note that the function code is AND'ed with ; IO$_VIRTUAL (63) to ensure that it stays within the ; range of the initialized action vector. ; .MACRO FDT_BUF CODES .IF NOT_DEFINED, FDT$$START FDT_INI .ENDC .SAVE DRIVER_DATA $$BUFH = 0 $$BUFL = 0 .IRP X, .IF GREATER, - 31 $$BUFH = $$BUFH ! <1 @ < - 32>> .IF_FALSE $$BUFL = $$BUFL ! <1 @ > .ENDC .ENDR . = FDT$$START + FDT$Q_BUFFERED .LONG $$BUFL,$$BUFH .RESTORE .ENDM FDT_BUF ; ; The FDT_ACT macro definition builds the action vector. ; The slot corresponding to each code in the CODES parameter is ; set to the routine address specified in the ACTION parameter. ; .MACRO FDT_ACT ACTION,CODES .IF NOT_DEFINED, FDT$$START FDT_INI .ENDC .SAVE DRIVER_DATA .IRP X, .IF GREATER, - 31 .IF NOT_EQUAL, $$DEFH & <1 @ < - 32>> .ERROR 0 ; Multiple actions defined for function IO$_'X ; .IF_FALSE $$DEFH = $$DEFH !< 1 @ < - 32>> . = FDT$$START + FDT$PS_FUNC_RTN + <4 * > .ADDRESS ACTION .ENDC .IF_FALSE .IF NOT_EQUAL, $$DEFL & <1 @ > .ERROR 0 ; Multiple actions defined for function IO$_'X ; .IF_FALSE $$DEFL = $$DEFL ! <1 @ > . = FDT$$START + FDT$PS_FUNC_RTN + <4 * > .ADDRESS ACTION .ENDC .ENDC .ENDR .RESTORE .ENDM FDT_ACT ; ; The FDT_64 macro builds the 64-bit functions mask ; from the function codes values passed in the CODES ; parameter. Note that the function code is AND'ed with ; IO$_VIRTUAL (63) to ensure that it stays within the ; range of the initialized action vector. ; .MACRO FDT_64 CODES .IF NOT_DEFINED, FDT$$START FDT_INI .ENDC .SAVE_PSECT DRIVER_DATA $$OK64H = 0 $$OK64L = 0 .IRP X, .IF GREATER, - 31 $$OK64H = $$OK64H ! <1 @ < - 32>> .IF_FALSE $$OK64L = $$OK64L ! <1 @ > .ENDC .ENDR . = FDT$$START + FDT$Q_OK64BIT .LONG $$OK64L,$$OK64H .RESTORE_PSECT .ENDM FDT_64 ; ; ; Obsolete STEP=1 function table entry macro ; .MACRO FUNCTAB ACTION,CODES .ERROR 0 ;FUNCTAB is an obsolete macro used by STEP=1 drivers; .PRINT 0 ;Use FDT_INI, FDT_BUF, and FDT_ACT instead; .ENDM ; ; GENERATE ADDRESS FOR DRIVER DISPATCH AND FUNCTION DECISION TABLES ; ; GENRADDR ADDRESS,DEFAULT ; ; Note that DEFAULT is set to IOC$RETURN to preserve existing ; behavior. ; .MACRO GENRADDR ADDRESS,DEFAULT=IOC$RETURN .IF IDENTICAL
,<0> .ADDRESS DEFAULT .IFF .ADDRESS ADDRESS .ENDC .ENDM GENRADDR ; ; I/O REQUEST COMPLETE ; ; REQCOM RETURN=rsb,ENVIRONMENT=JSB|CALL ; ; RETURN - "Caller's caller" return semantic (RSB - default, or RET) ; ENVIRONMENT - is an optional keyword that specifies the caller's ; environment as either JSB or CALL. The default is JSB. ; If specified as JSB, then the RETURN parameter is used. ; ; IMPLICIT INPUTS: ; ; R0 - First longword of I/O status by value ; R1 - Second longword of I/O status by value ; R5 - Unit Control Block ; ; IMPLICIT OUTPUTS: ; ; R0,R1 - Scratched ; .MACRO REQCOM RETURN=RSB,ENVIRONMENT=JSB .IF DIFFERENT,ENVIRONMENT,JSB ;validate environment keyword .IF DIFFERENT,ENVIRONMENT,CALL .ERROR 0 ;Keyword %EXTRACT(0,11,) must be either CALL or JSB; .ENDC .ENDC CALL_REQCOM ;ioc_std$reqcom (iost1=r0,iost2=r1,ucb=r5) .IF IDENTICAL,ENVIRONMENT,CALL RET ;return to caller .IF_FALSE RETURN ;return to caller .ENDC .ENDM REQCOM ; ; RELEASE ALL CHANNELS ; ; RELCHAN ; ; IMPLICIT INPUTS: ; ; R5 - Unit Control Block ; ; IMPLICIT OUTPUTS: ; ; R0,R1 - Scratched ; .MACRO RELCHAN CALL_RELCHAN ;ioc_std$relchan (ucb=r5) .ENDM RELCHAN ;++ ; ; REQUEST CHANNEL ; ; REQCHAN PRI=LOW|HIGH,ENVIRONMENT=JSB|CALL ; ; PRI - if identical to the string HIGH, then IOC$PRIMITIVE_REQPCHANH ; is called, otherwise IOC$PRIMITIVE_REQPCHANL is called ; ENVIRONMENT - is an optional keyword that specifies the callers and ; grant routine environment as either JSB or CALL. The default ; is JSB. If specified as JSB, then an RSB is used to return ; from the current routine if the channel is not granted ; immediately and a .JSB_ENTRY directive is used to generate ; the grant routine. If specified as CALL, then an RET is used ; to return from the current routine if the channel is not ; granted immediately, a .CALL_ENTRY directive is used to ; generate the grant routine, and the grant routine parameters ; are copied into R3, R4, and R5. ; ; IMPLICIT INPUTS: ; ; R5 - UCB address ; R3 - Passed on to channel grant fork routine, if called. ; ; IMPLICIT OUTPUTS: ; ; R4 - Contains the IDB address. ; R0,R1 - Scratched ;-- .MACRO REQCHAN PRI=LOW,ENVIRONMENT=JSB,?L1,?L2 .IF DIFFERENT,PRI,LOW ;validate PRI keyword .IF DIFFERENT,PRI,HIGH .ERROR 0 ;Keyword %EXTRACT(0,3,) must be either LOW or HIGH; .ENDC .ENDC .IF DIFFERENT,ENVIRONMENT,JSB ;validate ENVIRONMENT keyword .IF DIFFERENT,ENVIRONMENT,CALL .ERROR 0 ;Keyword %EXTRACT(0,11,) must be either CALL or JSB; .ENDC .ENDC $UCBDEF MOVAB L1,UCB$L_FPC(R5) ;store grant routine address in UCB SUBL #4,SP ;allocate space for returned IDB pointer PUSHAB (SP) ;P3 = pointer to IDB pointer PUSHL R5 ;P2 = UCB PUSHL R3 ;P1 = IRP .IF IDENTICAL,PRI,HIGH .GLOBAL IOC_STD$PRIMITIVE_REQCHANH CALLS #3,G^IOC_STD$PRIMITIVE_REQCHANH .IF_FALSE .GLOBAL IOC_STD$PRIMITIVE_REQCHANL CALLS #3,G^IOC_STD$PRIMITIVE_REQCHANL .ENDC POPL R4 ;R4 = IDB for return BLBS R0,L2 ;if not granted then return .IF IDENTICAL,ENVIRONMENT,CALL RET L1: .CALL_ENTRY PRESERVE= $OFFDEF ARG, MOVL ARG$_IRP(AP),R3 ;R3 = IRP MOVL ARG$_IDB(AP),R4 ;R4 = IDB MOVL ARG$_UCB(AP),R5 ;R5 = UCB .IF_FALSE ;IDENTICAL,ENVIRONMENT,CALL RSB L1: .JSB_ENTRY INPUT=,SCRATCH= .ENDC ;IDENTICAL,ENVIRONMENT,CALL L2: .ENDM REQCHAN ;++ ; ; REQUEST PRIMARY CHANNEL ; ; REQPCHAN PRI ; ; This is equivalent to REQCHAN. Please consult the description of REQCHAN. ; ;-- .MACRO REQPCHAN PRI,ENVIRONMENT REQCHAN PRI,ENVIRONMENT .ENDM REQPCHAN ;++ ; TIMEWAIT - obsolete, use TIMEDWAIT ;-- .MACRO TIMEWAIT TIME,BITVAL,SOURCE,CONTEXT,SENSE .ERROR ; TIMEWAIT is obsolete - use TIMEDWAIT; .ENDM ;++ ; ; TIMEDWAIT - Timed Wait Loop with Imbedded Tests ; ; Macro to wait for a specified interval of time. Instructions that test for ; various exit conditions may be imbedded within the wait loop, if so desired. ; ; INPUTS: ; ; TIME - the number of 10 micro-second intervals to wait ; INS1 - first instruction to imbed within wait loop ; INS2 - second instruction to imbed within wait loop ; INS3 - third instruction to imbed within wait loop ; INS4 - fourth instruction to imbed within wait loop ; INS5 - fifth instruction to imbed within wait loop ; INS6 - sixth instruction to imbed within wait loop ; DONELBL - label for exit from wait loop ; IMBEDLBL - Label for beginning of user supplied instructions ; UBLBL - Label for end of user supplied instructions ; NSEC - Number of nanoseconds to wait before timeout (cannot be used ; with TIME parameter) ; BUS - Address of ADP if a bus specific delay is required ; USERINS - list of user instructions. Allows use of more than 6 ; instructions. For example, USERINS=<,> ; ; OUTPUTS: ; ; R0 - indicates success or failure status. Success is defined as ; not timing out. Note that the status of SS$_NORMAL is preloaded ; into R0, but that the user instructions may overwrite this. ; Also note that the SS$_TIMEOUT status from the the ; EXE$TIMEDWAIT_COMPLETE call cannot be overwritten by the user ; code. ; R1 - destroyed, all other registers preserved. ; ;-- .MACRO TIMEDWAIT TIME,INS1,INS2,INS3,INS4,INS5,INS6,DONELBL,?IMBEDLBL,UBLBL,NSEC,BUS,USERINS,?L1 ; Stack usage: ; ; ^ +------------------------+ ; | stack | Addr(Delta_Time) | <- call argument #1 ; | growth +------------------------+ ; | Addr(End_Time) | <- call argument #2 ; +------------------------+ ; | Addr(End_Time) | <- saved ptr for later copying ; +------------------------+ ; | | <- potential spare longword ; +------------------------+ ; new SP->| | <- R1 (quad aligned) ; +- Delta time -+ ; | | ; +------------------------+ ; | | <- 8(R1) ; +- End Time -+ ; | | ; +------------------------+ ; SP-> | | ; . . ; . . ; . . ; ; First, quadword align the stack, handling arbitrary stack alignment SUBL2 #^X18,SP ; Make space for 2 quad aligned items ADDL3 #7,SP,R1 ; Round up SP, place into R1 BICL2 #7,R1 ; Compute quad aligned base PUSHAB 8(R1) ; Spare copy of END_VALUE address .IF NOT_BLANK, NSEC .NTYPE $$$ARGTYPE, NSEC .IF EQ <$$$ARGTYPE @ -4> - 5 ; If NSEC parameter is specified as EVAX_STQ NSEC,(R1) ; a register, then do a STQ directly. .IFF ; Otherwise do a LDQ/STQ sequence. EVAX_LDQ R0,NSEC ; Fetch the delta time EVAX_STQ R0,(R1) ; Save the delta time .ENDC .ENDC .IF NOT_BLANK, TIME .IIF NOT_BLANK, NSEC, .ERROR ; TIMEDWAIT: MULTIPLE TIMING PARAMETERS SPECIFIED MOVL TIME,R0 ; Load 10 microsecond count into R0 EVAX_MULQ #10000,R0,R0 ; Compute nanoseconds (10 * 1000 per 10 usec) EVAX_STQ R0,(R1) ; Save the delta time .ENDC PUSHAQ 8(R1) ; Place argument #2 (END_VALUE addr) PUSHAQ (R1) ; " " #1 (DELTA addr) CALLS #2,G^EXE$TIMEDWAIT_SETUP; Set up end value BLBC R0,L1 ; Just exit on error ; Imbedded label and user specified instructions ; First, set up the INS instructions for the existing invocations ; Then, add the USERINS instruction list. IMBEDLBL: 'INS1' 'INS2' 'INS3' 'INS4' 'INS5' 'INS6' .IF NOT_BLANK, .IRP INST, INST .ENDR .ENDC .IIF NOT_BLANK, UBLBL, UBLBL: ; Label at end of user instructions ; Add bus specific delay, if requested .IF NOT_BLANK, BUS PUSHL BUS ; Save ADP address CALLS #1,G^EXE$BUS_DELAY ; Adapter specific delay .ENDC ; End of loop test - check for completion (timeout) PUSHL (SP) ; Copy END_VALUE pointer CALLS #1,G^EXE$TIMEDWAIT_COMPLETE ; Check for completion BLBS R0,IMBEDLBL ; Loop if not yet done ; Exit point - clean up the stack .IIF NOT_BLANK, DONELBL, DONELBL: ; Termination label for exits L1: ADDL2 #<^X18+4>,SP ; Restore SP .ENDM TIMEDWAIT ;++ ; ; TIMEDELAY - Delay for a specific amount of time ; ; TIMEDELAY TIME ; ; TIME - number of nanoseconds to delay (quadword) ; ;-- .MACRO TIMEDELAY TIME SUBL2 #^X10,SP ; Make space for 1 quad aligned item ADDL3 #7,SP,R0 ; Round up SP, place into R1 BICL2 #7,R0 ; Compute quad aligned base EVAX_STQ TIME,(R0) ; Store the delay time PUSHL R0 ; Point to the delay time CALLS #1,G^EXE$DELAY ; Execute the delay ADDL2 #^X10,SP ; Restore the stack .ENDM ;++ ; ; WAITFOR INTERRUPT OR TIMEOUT AND KEEP CHANNEL ; ; WFIKPCH EXCPT,TIME,NEWIPL,RETURN=rsb,ENVIRONMENT=JSB|CALL,TOUTROUT ; ; EXCPT - label of the timeout handling code within the interupt context ; routine that follows the WFIKPCH macro. ; TIME - timeout value in seconds. This value is loaded into R1 before ; calling IOC_STD$PRIMITIVE_WFIKPCH. ; NEWIPL - specifies the new IPL that is set on return from ; IOC_STD$PRIMITIVE_WFIKPCH. This value is loaded into R2 ; before calling IOC_STD$PRIMITIVE_WFIKPCH. ; RETURN - "Caller's caller" return semantic (RSB - default, or RET) ; ENVIRONMENT - is an optional keyword that specifies the current and ; resume routine environment as either JSB or CALL. The default ; is JSB. If specified as JSB, then the RETURN parameter is ; used to generate a returns from the current routine and a ; .JSB_ENTRY directive is used to generate the resume routine. ; If specified as CALL, then the RETURN parameter is ignored ; and assumed to be RET, a .CALL_ENTRY directive is used to ; generate the resume routine, the IRP, FR4, and UCB parameters ; in the resume routine are copied into R3, R4, and R5. ; TOUTROUT - is an optional parameter that specifies the timeout routine ; entry point which can be either a CALL or JSB entry point. ; If not specified then the resume routine entry point is also ; used as the timeout routine entry point. This paramter can ; not be specified together with the EXCPT parameter. ; ; IMPLICIT INPUTS: ; ; R3 - IRP pointer, passed on to fork routine ; R4 - Passed on to fork routine, full 64-bits ; R5 - UCB address ; ; IMPLICIT OUTPUTS: ; ; R0,R1,R2 - Scratched ; ;-- .MACRO WFIKPCH EXCPT,TIME,NEWIPL=(SP)+,RETURN=RSB,ENVIRONMENT=JSB,- TOUTROUT,?L1 .IF DIFFERENT,ENVIRONMENT,JSB ;validate ENVIRONMENT keyword .IF DIFFERENT,ENVIRONMENT,CALL .ERROR 0 ;Keyword %EXTRACT(0,11,) must be either CALL or JSB; .ENDC .ENDC .IF NOT_BLANK,TOUTROUT ;disallow both EXCPT, TOUTROUT .IF NOT_BLANK,EXCPT .ERROR 0 ;%EXTRACT(0,5,) label and %EXTRACT(0,5,) routine disallowed together; .ENDC .ENDC $UCBDEF .IF BLANK,TIME ASHL #16,#1,R1 .IF_FALSE .IF DIFFERENT,