/*	**************************************************************  */
/*
 *	Module K7011
 *	This module contains I/O functions for the Keithley 7011
 *	multiplexer card in the model 7001 chassis.                 
 *
 *	Zachary Wolf
 *	8/23/98
 */ 

/*	**************************************************************  */

/*	INCLUDES  */
#include <utility.h>
#include <gpib.h>
#include <formatio.h>
#include <ansi_c.h>
#include "k7011.h"

/*	**************************************************************  */

/*  PRIVATE FUNCTIONS  */
int k7011_open_dev(int gpib_board_addr, int gpib_dev_addr);
void k7011_close_dev(int dev_ID);
int k7011_out(int dev_ID, char* buf);
int k7011_in(int dev_ID, char* buf);
int k7011_check_device_open(int dev_ID);
int k7011_get_errors(int dev_ID);
void k7011_message(char* msg);
void k7011_error(char* msg);

/*	**************************************************************  */

/*	PRIVATE DEVICE TABLE  */
/*
 *	This table allows several devices of the same type to be
 *	used in the system.
 *  dev_addr, contains the GPIB addresses of opened devices
 *  dev_descr, contains the device descriptors of opened devices
 *  dev_count, contains the number of devices open of this type
 */
static int dev_addr[K7011_MAX_NUM_DEV + 1];
static int dev_descr[K7011_MAX_NUM_DEV + 1];
static int dev_count;

/*	**************************************************************  */

/*  PRIVATE GLOBAL VARIABLES  */
/*
 *  cmd, buffer for GPIB I/O strings
 *  msg, buffer for message strings to Standard I/O
 */
static char cmd[K7011_MAX_CMD + 1];
static char msg[K7011_MAX_CMD + 1];

/*	**************************************************************  */

/*	PUBLIC FUNCTIONS  */

/*	**************************************************************  */
/*
 *  k7011_init
 *  This function opens the device, queries for ID, and
 *  initializes the device to a known state.
 *
 *	Input:
 *	gpib_board_addr, address of the GPIB board the device is conected to (0, 1, ...)
 *	gpib_dev_addr, GPIB address of the device (1 to 30, 0 is reserved)
 *
 *	Output:
 *	dev_ID, identifier for future references to the device
 *
 *	Zachary Wolf
 *	8/23/98
 */

void k7011_init(int gpib_board_addr, int gpib_dev_addr, int* ID)
{
    /* Declare variables */
    int dev_ID;
    int err;
    
    /* Message */
    k7011_message("");
    k7011_message("Initializing the K7011...");

    /* Check input parameters */
    if (gpib_board_addr < 0 || gpib_board_addr > 10)
    {
    	Fmt(msg, "%s<gpib_board_addr = %i, out of range", gpib_board_addr);
    	k7011_error(cmd);
    	return;
    }
    if (gpib_dev_addr < 1 || gpib_dev_addr > 30)
    {
    	Fmt(msg, "%s<gpib_dev_addr = %i, out of range", gpib_dev_addr);
    	k7011_error(msg);
    	return;
    }
    
    /* Exit if testing without hardware */
    #ifdef DUMMY_DEVICES
    	*ID = 1;
    	return;
    #endif
    
    /* Open the K7011 */
    dev_ID = k7011_open_dev(gpib_board_addr, gpib_dev_addr);
    if (dev_ID <= 0)
    {
        k7011_error("Device was not opened");
        return;
    }
    
    /* Have the 7011 perform its reset function */
    k7011_out(dev_ID, "*RST");
    
    /* Clear the error registers */
    k7011_out(dev_ID, "*CLS");
    
    /* Enable status information to be obtained */
    Fmt(cmd, "%s<*ESE %i", 4 + 8 + 16 + 32);
    k7011_out(dev_ID, cmd);
    
    /* Make sure all channels are open */
    k7011_out(dev_ID, ":OPEN ALL");
    
    /* Get the ID */
    k7011_out(dev_ID, "*IDN?");
    err = k7011_in(dev_ID, cmd);
    if (err != 0)
    {
        k7011_error("Problem reading ID");
        k7011_close_dev(dev_ID);
        return;
    }
    k7011_message(cmd);

	/* Return the ID number */
    *ID = dev_ID;
    
    /* Done */
    return;
}

/*	**************************************************************  */
/*
 *	k7011_open_all
 *  This function opens all channels of the multiplexer.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Zachary Wolf
 *	8/23/98
 */

void k7011_open_all(int dev_ID)
{
	/* Declare variables */
	int dev_open;
	int err;

    /* Check input parameters */
    if (dev_ID < 1 || dev_ID > K7011_MAX_NUM_DEV)
    {
    	Fmt(msg, "%s<dev_ID = %i, out of range", dev_ID);
    	k7011_error(msg);
    	return;
    }
    
    /* Exit if testing without hardware */
    #ifdef DUMMY_DEVICES
    	return;
    #endif
    
    /* Check to make sure the device is open */
    dev_open = k7011_check_device_open(dev_ID);
    if (dev_open != 1)
    {
    	k7011_error("Device not open");
    	return;
    }
    
    /* Open all channels */
    k7011_out(dev_ID, ":OPEN ALL");
    
    /* Check for errors */
    err = k7011_get_errors(dev_ID);
    if (err != 0)
    {
        k7011_error("The device has an error");
        k7011_close_dev(dev_ID);
        return;
    }
    
    /* Done */
    return;
}

/*	**************************************************************  */
/*
 *	k7011_close_card_chan
 *  This function closes the specified channel on the specified
 *	card.
 *
 *	Input:
 *	dev_ID, device identifier
 *	card, the card number (1 or 2) 
 *	chan, the channel number (1 to 40)
 *
 *	Zachary Wolf
 *	8/23/98
 */

void k7011_close_card_chan(int dev_ID, int card, int chan)
{
	/* Declare variables */
	int dev_open;
	int err;

    /* Check input parameters */
    if (dev_ID < 1 || dev_ID > K7011_MAX_NUM_DEV)
    {
    	Fmt(msg, "%s<dev_ID = %i, out of range", dev_ID);
    	k7011_error(msg);
    	return;
    }
    if (card < 1 || card > 2)
    {
    	Fmt(msg, "%s<card = %i, out of range", card);
    	k7011_error(msg);
    	return;
    }
    if (chan < 1 || chan > 40)
    {
    	Fmt(msg, "%s<chan = %i, out of range", chan);
    	k7011_error(msg);
    	return;
    }
    
    /* Exit if testing without hardware */
    #ifdef DUMMY_DEVICES
    	return;
    #endif
    
    /* Check to make sure the device is open */
    dev_open = k7011_check_device_open(dev_ID);
    if (dev_open != 1)
    {
    	k7011_error("Device not open");
    	return;
    }

    /* Close the channel on the card */
    Fmt(cmd, "%s<:CLOSE (@%i[w1]!%i)", card, chan);
    k7011_out(dev_ID, cmd);
    
    /* Give the channel time to close */
    Delay(.2);
    
    /* Check for errors */
    err = k7011_get_errors(dev_ID);
    if (err != 0)
    {
        k7011_error("The device has an error");
        k7011_close_dev(dev_ID);
        return;
    }
    
    /* Done */
    return;
}

/*	**************************************************************  */
/*
 *	k7011_exit
 *  This function puts the K7011 in a desired state and closes the device.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Zachary Wolf
 *	8/23/98
 */

void k7011_exit(int dev_ID)
{
	/* Declare variables */
	int dev_open;
	int err;

    /* Check input parameters */
    if (dev_ID < 1 || dev_ID > K7011_MAX_NUM_DEV)
    {
    	Fmt(msg, "%s<dev_ID = %i, out of range", dev_ID);
    	k7011_error(msg);
    	return;
    }
    
    /* Exit if testing without hardware */
    #ifdef DUMMY_DEVICES
    	return;
    #endif
    
    /* Check to make sure the device is open */
    dev_open = k7011_check_device_open(dev_ID);
    if (dev_open != 1)
    {
    	return;		 /* OK, already closed */
    }
    
    /* Put the K7011 in the appropriate state for program exit */
    /* Open all channels */
	k7011_open_all(dev_ID);

	/* Close the device */
    k7011_close_dev(dev_ID);
    
    /* Done */
    return;
}

/*	**************************************************************  */

/*	PRIVATE FUNCTIONS  */

/*	**************************************************************  */
/*
 *	k7011_open_dev
 *	This function opens the device and returns an identifier for
 *	future references to the device.
 *
 *	Input:
 *	gpib_board_addr, address of the GPIB board the device is connected to
 *	gpib_dev_addr, GPIB address of the device (1 to 30, 0 is reserved)
 *
 *	Output:
 *	dev_ID, device identifier for future references to the device (-1 if there is a problem)
 *
 *	Zachary Wolf
 *	8/23/98
 */

int k7011_open_dev(int gpib_board_addr, int gpib_dev_addr)
{
	/* Declare variables */
    int i;
    int dev_ID;
    int descr;
    int err;

    /* Check input parameters */
    if (gpib_board_addr < 0 || gpib_board_addr > 10)
    {
    	Fmt(msg, "%s<gpib_board_addr = %i, out of range", gpib_board_addr);
    	k7011_error(cmd);
    	return -1;
    }
    if (gpib_dev_addr < 1 || gpib_dev_addr > 30)
    {
    	Fmt(msg, "%s<gpib_dev_addr = %i, out of range", gpib_dev_addr);
    	k7011_error(msg);
    	return -1;
    }

	/* Initialization */
    dev_ID = 0;

    /* Check to see if the device is already in the device table */
    for (i = 1; i <= K7011_MAX_NUM_DEV; i++)
    {
        if (dev_addr[i] == gpib_dev_addr)
        {
            dev_ID = i;
            return dev_ID;
        }
    }
    
    /* Find an ID for the device */
	for (i = 1; i <= K7011_MAX_NUM_DEV; i++)
	{
		if (dev_addr[i] == 0)
		{
			dev_ID = i;
			break;
		}
	}
     
    /* If an entry could not be opened in the device table, return an error */
    if (dev_ID <= 0)
    {
    	k7011_error("The device could not be opened");
        return  -1;
    }
    
	/* Open the device */
    /* Terminate write with EOI */
    /* Terminate read on LF, remove LF in read routine */
	descr = ibdev(gpib_board_addr, gpib_dev_addr, 0, T10s, 1, 0x140A);
	if (descr <= 0)
	{
		k7011_error("The device could not be opened");
		return  -1;
	}
   
    /* Open successful, save parameters in device table */
    dev_addr[dev_ID] = gpib_dev_addr;
    dev_descr[dev_ID] = descr;
    dev_count++;
    
    /* Clear the device */
	err = ibclr(dev_descr[dev_ID]);
	if (err & 0x8000)
	{
		k7011_error("Problem clearing device");
    }
    
    /* Return the device ID */
    return dev_ID;
}

/*	**************************************************************  */
/*
 *	k7011_close_dev
 *  This function closes the device.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Zachary Wolf
 *	8/3/98
 */

void k7011_close_dev(int dev_ID)
{
	/* Close the device */
    if (dev_descr[dev_ID] != 0)
    {
        ibonl(dev_descr[dev_ID], 0);
        dev_descr[dev_ID] = 0;
        dev_addr[dev_ID] = 0;
        dev_count--;
    }
    
    /* Done */
    return;
}


/*	**************************************************************  */
/*
 *	k7011_out
 *  This function writes a buffer of data to the device.
 *
 *	Input:
 *	dev_ID, device identifier
 *	buf, null terminated string, the contents up to \0 are sent
 *
 *	Output:
 *	err, 0 if ok, -1 otherwise
 *
 *	Zachary Wolf
 *	8/23/98
 */

int k7011_out(int dev_ID, char* buf)
{
	/* Declare variables */
	int nbytes;
	int err;
	
	/* Send the message */
	nbytes = StringLength(buf);
	err = ibwrt(dev_descr[dev_ID], buf, (long)nbytes);
	
	/* Check for errors */
	if (err & 0x8000)
	{
		Fmt(msg, "%s<ibsta = %x, problem sending GPIB command", err);
		k7011_error(msg);
		return -1;
	}
	
	/* Done */
    return 0;
}

/*	**************************************************************  */
/*
 *	k7011_in
 *  This function reads a buffer of data from the device.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Output:
 *	buf, null terminated string, the contents from the device
 *	err, 0 if ok, -1 otherwise
 *
 *	Zachary Wolf
 *	8/23/98
 */

int k7011_in(int dev_ID, char* buf)
{
	/* Declare variables */
	int err;
	char in_buf[K7011_MAX_CMD];
	
	/* Read the message */
	err = ibrd(dev_descr[dev_ID], in_buf, K7011_MAX_CMD);
	
	/* Check for errors */
	if (err & 0x8000)
	{
		Fmt(msg, "%s<ibsta = %x, problem receiving GPIB input", err);
		k7011_error(msg);
		return -1;
	}
	
	/* Remove the LF terminator */
	Scan(in_buf, "%l>%s[t-]", buf);
	
	/* Done */
    return 0;
}

/*	**************************************************************  */
/*
 *	k7011_check_device_open
 *  This function checks to see if the specified device is open.
 *	If the device has been opened, a 1 is returned, 0 otherwise.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Output:
 *	status, 1 if device is open, 0 otherwise
 *
 *	Zachary Wolf
 *	7/27/98
 */

int k7011_check_device_open(int dev_ID)
{
	/* See if the board descriptor has a positive value */
    if (dev_descr[dev_ID] > 0)
    {
        return  1;
    }
    else
    {
	    return 0;
	}
}

/*	**************************************************************  */
/*
 *	k7011_get_errors
 *  This function obtains device errors.
 *	The operator is alerted if there is an error.
 *
 *	Input:
 *	dev_ID, device identifier
 *
 *	Output:
 *	err, 0 if no errors, -1 otherwise
 *
 *	Zachary Wolf
 *	8/3/98
 */

int k7011_get_errors(int dev_ID)
{
	/* Declare variables */
    int status;
    int err;

	/* Get the error status */
	k7011_out(dev_ID, "*ESR?");
	k7011_in(dev_ID, cmd);
	
	/* Extract the status value */
	err = Scan(cmd, "%s>%i", &status);
    if (err != 1)
    {
        k7011_error("Problem getting error status");
        return -1;
    }
    
    /* Alert the operator if there is an error */
    if (status != 0)
    {
		Fmt(msg, "%s<K7011 error code = %i", status);
    	k7011_error(msg);
        return -1;
    }
    
    /* Done */
    return 0;
}

/*	**************************************************************  */
/*
 *	k7011_message
 *  This function handles messages about the K7011.
 *
 *	Input:
 *	message, string to display in standard I/O
 *
 *	Zachary Wolf
 *	8/3/98
 */

void k7011_message(char* message)
{
	/* Print the message */
	printf("%s\n", message);
	
	/* Done */
	return;
}

/*	**************************************************************  */
/*
 *	k7011_error
 *  This function handles error messages for the K7011.
 *
 *	Input:
 *	message, string to display in standard I/O
 *
 *	Zachary Wolf
 *	8/3/98
 */

void k7011_error(char* message)
{
	/* Declare variables */
	char buf[80];
	
	/* Notify the operator of the error */
	printf("\nK7011 ERROR: %s\n", message);
	Beep();
	Delay(.5);
	Beep();
	
	/* Terminate the program if the operator desires */
	printf("Press ENTER to continue.\nPress any key then ENTER to terminate program.\n");
	fgets(buf, 80, stdin);
	if (buf[0] == '\n') return;
	else exit(0);
}