;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Copyright (c) 2001 - 2002 TIMEX Corporation.
; 
; This document is the property of, and contains information proprietary to
; TIMEX Corporation.  It is to be returned upon request.  Reproduction by any
; means, disclosure, or use of its contents for other than the expressed
; purpose for which it is loaned, without the written consent of TIMEX
; Corporation, is strictly prohibited.
;
; File Name      : kbckmac.h
;
; Macro Names    :
;
;   ( ALLOCATION )
;
;   KBCK_RELEASE_ALL_RESOURCES        - Releases all backup check resources and 
;                                         makes them available.
;   KBCK_RELEASE_RESOURCE             - Releases all backup check resources with 
;                                         a specified application index.
;   KBCK_RESERVE_RESOURCE             - Reserves a backup check resource for a 
;                                         specified application index.
;
;   ( PROPERTY SETTING )
;
;   KBCK_ACTIVATE_RESOURCE            - Allows update every minute to the snooze 
;                                         data in the resource.
;   KBCK_DEACTIVATE_RESOURCE          - Disallows updates every second to the data 
;                                         in the resource.
;   KBCK_DEACTIVATE_ALL_RESOURCES     - Deactivates all backup check resources by 
;                                         clearing the active flag.
;   KBCK_SETUP_POPUP_GENERATION       - Setup resource to generate popup when snooze 
;                                         time expires.
;   KBCK_SETUP_EVENT_GENERATION       - Setup resource to generate event when snooze 
;                                         time expires.
;   KBCK_CANCEL_POPUPEVENT_GENERATION - Cancel resource to generate popup and event 
;                                         when snooze time expires.
;
;   ( DATA MANIPULATION )
;
;   KBCK_RETURN_RESOURCE_OWNER        - Returns the owner of the specified resource 
;                                         index.
;   KBCK_GET_APP_FIRST_RESOURCE       - Returns the first backup check resource index 
;                                         assigned to a specified application.
;   KBCK_SETUP_SNOOZE_TIME            - Sets up the snooze time of the specified resource 
;                                         index.        
;   KBCK_CHECK_ALL_RESOURCES          - Checks all active resources.  A request for a 
;                                         popup or event is passed to the kernel.
;   KBCK_UPDATE_ALL_ACTIVE_RESOURCES  - Checks all active resources.  A request for a 
;                                         popup or event is passed to the kernel.
;
;   
; Purpose        : Kernel Backup Check Resource Macro File
;
; Change History : 
;
;                  11/26/2001 FSU - Created file
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_RELEASE_ALL_RESOURCES
;
; Description : Releases all backup check resources and makes them available.
;
; Assumptions : None
;                         
; Usage       : KBCK_RELEASE_ALL_RESOURCES
;               
; Input(s)    : None    
;
; Output(s)   : None
;
;               ( Destroys: IYReg, BReg )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_RELEASE_ALL_RESOURCES  MACRO

                car     kbckReleaseAllResources
                                
        CALLS   SUBROUTINE, 'kbckReleaseAllResources'
       
        ENDM
                                
                                
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_RELEASE_RESOURCE
;
; Description : Releases all backup check resources with a specified application index.
;
; Assumptions : None
;                         
; Usage       : KBCK_RELEASE_RESOURCE
;               
; Input(s)    : AReg - Application Index    
;
; Output(s)   : None
;
;               ( Destroys: BReg )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_RELEASE_RESOURCE   MACRO

                car     kbckReleaseResource
                                
        CALLS   SUBROUTINE, 'kbckReleaseResource'
       
        ENDM
                                
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_RESERVE_RESOURCE
;
; Description : Reserves a backup check resource for a specified application 
;                 index. This returns the reserved resource index if there was 
;                 one, and returns KBCKERRORCODE code if there was none.
;
; Assumptions : None
;                         
; Usage       : KBCK_RESERVE_RESOURCE
;               
; Input(s)    : AReg - Application Index
;
; Output(s)   : BReg - Resource Index - if a resource was reserved
;                      KBCKERRORCODE  - if no resource was reserved
;
;               ( Destroys: AReg )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_RESERVE_RESOURCE   MACRO

                car     kbckReserveResource
                                
        CALLS   SUBROUTINE, 'kbckReserveResource'
       
        ENDM


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_ACTIVATE_RESOURCE
;
; Description : Allows update every minute to the snooze data in the resource.
;
; Assumptions : None
;                         
; Usage       : KBCK_ACTIVATE_RESOURCE
;               
; Input(s)    : AReg - Resource Index to activate.  
;
; Output(s)   : None
;
;               ( Destroys: BReg )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_ACTIVATE_RESOURCE  MACRO

                car     kbckActivateResource
                                
        CALLS   SUBROUTINE, 'kbckActivateResource'
       
        ENDM                



;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_DEACTIVATE_RESOURCE
;
; Description : Disallows updates every second to the data in the resource.
;
; Assumptions : None
;                         
; Usage       : KBCK_DEACTIVATE_RESOURCE
;               
; Input(s)    : AReg - Resource Index   
;
; Output(s)   : None
;                       
;               ( Destroys: BAReg, HLReg, IYReg )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_DEACTIVATE_RESOURCE    MACRO

                car     kbckDeactivateResource
                                
        CALLS   SUBROUTINE, 'kbckDeactivateResource'
       
        ENDM            



;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_DEACTIVATE_ALL_RESOURCES
;
; Description : Deactivates all backup check resources by clearing the active
;                 flag.
;
;               This prevents updates to all backup check resource variables.
;
; Assumptions : None
;                         
; Usage       : KBCK_DEACTIVATE_ALL_RESOURCES
;               
; Input(s)    : None
;
; Output(s)   : None
;               ( Destroys: None )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_DEACTIVATE_ALL_RESOURCES   MACRO

                car     kbckDeactivateAllResources
                                
        CALLS   SUBROUTINE, 'kbckDeactivateAllResources'
       
        ENDM


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_SETUP_POPUP_GENERATION
;
; Description : Setup resource to generate popup when snooze time expires.
;
; Assumptions : None
;                         
; Usage       : KBCK_SETUP_POPUP_GENERATION
;               
; Input(s)    : AReg - Resource Index
;
; Output(s)   : None
;                           
;               ( Destroys: BReg )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_SETUP_POPUP_GENERATION MACRO

                car     kbckSetupPopupGeneration
                                
        CALLS   SUBROUTINE, 'kbckSetupPopupGeneration'
       
        ENDM


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_SETUP_EVENT_GENERATION
;
; Description : Setup resource to generate event when snooze time expires.
;
; Assumptions : None
;                         
; Usage       : KBCK_SETUP_EVENT_GENERATION
;               
; Input(s)    : AReg - Resource Index
;
; Output(s)   : None
;
;               ( Destroys: None )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_SETUP_EVENT_GENERATION MACRO

                car     kbckSetupEventGeneration
                                
        CALLS   SUBROUTINE, 'kbckSetupEventGeneration'
       
        ENDM


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_CANCEL_POPUPEVENT_GENERATION
;
; Description : Cancel resource to generate popup and event when snooze time expires.
;
; Assumptions : None
;                         
; Usage       : KBCK_CANCEL_POPUPEVENT_GENERATION
;               
; Input(s)    : AReg - Resource Index
;
; Output(s)   : None
;
;               ( Destroys: None )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_CANCEL_POPUPEVENT_GENERATION   MACRO

                car     kbckCancelPopupEventGeneration
                                
        CALLS   SUBROUTINE, 'kbckCancelPopupEventGeneration'
       
        ENDM

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_RETURN_RESOURCE_OWNER
;
; Description : Returns the owner of the specified resource index.
;
; Assumptions : None
;                         
; Usage       : KBCK_RETURN_RESOURCE_OWNER
;               
; Input(s)    : AReg - Resource Index
;
; Output(s)   : BReg - Application index.
;
;               ( Destroys: None)
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_RETURN_RESOURCE_OWNER  MACRO

                car     kbckReturnResourceOwner
                                
        CALLS   SUBROUTINE, 'kbckReturnResourceOwner'
       
        ENDM



;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_GET_APP_FIRST_RESOURCE
;
; Description : Returns the first backup check resource index assigned to a
;                 specified application.
;
; Assumptions : None
;                         
; Usage       : KBCK_GET_APP_FIRST_RESOURCE
;               
; Input(s)    : AReg - Application index.
;
; Output(s)   : BReg = Resource Index - if the active application exist
;                    = KBCKERRORCODE - if there was none
;
;               ( Destroys: None )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_GET_APP_FIRST_RESOURCE MACRO

                car     kbckGetAppFirstResource
                                
        CALLS   SUBROUTINE, 'kbckGetAppFirstResource'
       
        ENDM


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_SETUP_SNOOZE_TIME
;
; Description : Sets up the snooze time of the specified resource index.
;
;               Cancel the queued backup check resource of the same type.
;
; Assumptions : None
;                         
; Usage       : KBCK_SETUP_SNOOZE_TIME
;               
; Input(s)    : AReg - Resource index.
;               BReg - Snooze time. (HEX data)
;
; Output(s)   : None
;
;               ( Destroys: None )
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_SETUP_SNOOZE_TIME  MACRO

                car     kbckSetupSnoozeTime
                                
        CALLS   SUBROUTINE, 'kbckSetupSnoozeTime'
       
        ENDM                



;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;
; Macro Name  : KBCK_CHECK_ALL_RESOURCES / KBCK_UPDATE_ALL_ACTIVE_RESOURCES
;
; Description : Checks all active resources.  A request for a popup or event
;                 is passed to the kernel.
;
; Assumptions : None
;                         
; Usage       : KBCK_CHECK_ALL_RESOURCES / KBCK_UPDATE_ALL_ACTIVE_RESOURCES
;               
; Input(s)    : None
;
; Output(s)   : None
;
;               ( Destroys: None)
;
; Macro Change History : 
;
;               11/26/2001 FSU  - Created macro
;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                        
KBCK_CHECK_ALL_RESOURCES    MACRO

                car     kbckCheckAllResources
                                
        CALLS   SUBROUTINE , 'kbckCheckAllResources'
       
        ENDM


KBCK_UPDATE_ALL_ACTIVE_RESOURCES    MACRO

                car     kbckCheckAllResources

        CALLS   SUBROUTINE , 'kbckCheckAllResources'
       
        ENDM
