% Copyright (c) 2023 SpinCore Technologies, Inc.
% http://www.spincore.com
% 
% This software is provided 'as-is', without any express or implied warranty. 
% In no event will the authors be held liable for any damages arising from the 
% use of this software.
% 
% Permission is granted to anyone to use this software for any purpose, 
% including commercial applications, and to alter it and redistribute it
% freely, subject to the following restrictions:
% 
% 1. The origin of this software must not be misrepresented; you must not
% claim that you wrote the original software. If you use this software in a
% product, an acknowledgment in the product documentation would be appreciated
% but is not required.
% 2. Altered source versions must be plainly marked as such, and must not be
% misrepresented as being the original software.
% 3. This notice may not be removed or altered from any source distribution.
%

%
% \file subtest.m adapted from subtest.c
% \brief PulseBlasterESR-PRO example program. This demonstrates the use of the 
% subroutine instruction.
%  
% \ingroup ESRPRO
clc; clear;

global SPINAPI_DLL_NAME

SPINAPI_DLL_NAME = 'spinapi64';

addpath('../MATLAB_SpinAPI'); % MATLAB_SpinAPI Folder path address

SpinAPI_Drive = 'C:'; % Modify to the hard drive letter that contains SpinAPI

% Loads spinapi64 library and headers
% All files are located in SpinAPI folder
if ~libisloaded('spinapi64')  % Needs the MinGW-w64 add-on
    loadlibrary([SpinAPI_Drive,'\SpinCore\SpinAPI\lib\spinapi64.dll'], ...
                 [SpinAPI_Drive,'\SpinCore\SpinAPI\include\spinapi.h'], 'addheader',...
                 [SpinAPI_Drive,'\SpinCore\SpinAPI\include\pulseblaster.h'], 'addheader',...
                 [SpinAPI_Drive,'\SpinCore\SpinAPI\include\radioprocessor.h'], 'addheader',...
                 [SpinAPI_Drive,'\SpinCore\SpinAPI\include\dds.h']);
end

% Load constants to the workspace as variables
load('CONST.mat');

argv = [0];
argc = arg(argv);
clock_freq = 500;

% Uncommenting the line below will generate a debug log in your current
% directory that can help debug any problems that you may be experiencing   
pb_set_debug(1);

fprintf('Copyright (c) 2023 SpinCore Technologies, Inc.\n\n');

fprintf('Using SpinAPI library version %s \n', pb_get_version());


numBoards = detect_boards(); % If there is more than one board in the system, have the user specify.
if numBoards > 1             % Request the board number to use from the user
    select_boards(numBoards)
end

if pb_init() ~= 0
  error('Error initializing board: %s\n', pb_get_error());
end

% Set the clock frequency.
if length(argv) > 1
    clock_freq = str2double(argv(1));
else
    % User input clock
    clock_freq = input_clock();
    fprintf('\n');
end
  
fprintf('Using clock frequency: %.2fMHz\n\n', clock_freq);
fprintf('BNCs 0-3 will output a train of pulses, each high for 50 ns, followed by ground level for 250 ns.  This pattern will then repeat.\n\n');

% Tell driver what clock frequency the board uses
pb_core_clock(clock_freq);

% Begin pulse program
pb_start_programming(PULSE_PROGRAM);

% Instruction format
% int pb_inst_pbony(int flags, int inst, int inst_data, int length)

% Instruction 0 - continue to inst 1 in 100ns
start = pb_inst_pbonly(0, CONTINUE, 0, 100.0 * ns);

% Instruction 1 - Jump to subroutine
sub = 3;
pb_inst_pbonly(0, JSR, sub, 50.0 * ns);

% Instruction 2 - Branch back to the beginning of the program
% (instruction 0)
pb_inst_pbonly(0, BRANCH, start, 100.0 * ns);

% Instruction 3 - This is the start of the subroutine. Turn on
% the BNC outputs for 50ns, and then return to the instruction
% immediately after the JSR instruction that called this. In this
% pulse program, the next instruction that will be executed is
% instruction 2.
pb_inst_pbonly(bitor(hex2dec(ON), hex2dec('F')), RTS, 0, 50.0 * ns);

% End of programming registers and pulse program
pb_stop_programming();

% Trigger pulse program
pb_reset();
pb_start();

pb_close();

fprintf('Press enter to continue...\n')
pause;

% Unload library and free memory
unloadlibrary('spinapi64');


function argc = arg(varargin)
    argc = nargin;
end

function numBoards = detect_boards()
    numBoards = pb_count_boards();
    if numBoards < 1
        error(['No Boards were detected in your system. Verify that the board is', ...
            ' firmly secured in the PCI slot.']);
    end
end

function select_boards(numBoards)
    while true
        fprintf('Found %d boards in your system. ', numBoards);
        fprintf('Which board should be used? (0-%d): ', (numBoards-1));
        choice = input('');
        if choice < 0 || choice > numBoards-1
            fprintf('Invalid Board Number (%d).\n', choice);
        else 
            pb_select_board(choice);
            fprintf('Board %d selected.\n',choice);
            break
        end 
    end 
end 

function clock = input_clock()
    clock = input('\nPlease enter internal clock frequency (MHz): ');
end