devMrmBuf.cpp File Reference

#include "devObj.h"
#include "mrf/object.h"
#include "mrf/databuf.h"
#include "mrmDataBufTx.h"
#include <epicsExport.h>
#include "devMrmBuf.h"

Include dependency graph for devMrmBuf.cpp:

Go to the source code of this file.

Classes
struct	mrmBufferInfo

Macros
#define	BUF_RX   ":BUFRX"
#define	BUF_TX   ":BUFTX"

Functions
mrmBufferInfo_t *	mrmBufInit (const char *dev_name)
	Initialize buffer data structure. More...
epicsStatus	mrmBufRxSupported (mrmBufferInfo_t *data)
	Checks whether receive buffer is supported. More...
epicsStatus	mrmBufTxSupported (mrmBufferInfo_t *data)
	Checks whether transferring buffer is supported. More...
epicsStatus	mrmBufEnable (mrmBufferInfo_t *data)
	Disable buffer sending logic. More...
epicsStatus	mrmBufDisable (mrmBufferInfo_t *data)
	Disable buffer sending logic. More...
epicsStatus	mrmBufMaxLen (mrmBufferInfo *data, epicsUInt32 *maxLength)
	Get maximum supported buffer length. More...
epicsStatus	mrmBufSend (mrmBufferInfo *data, epicsUInt32 len, epicsUInt8 *buf)
	Send buffer data. More...
epicsStatus	mrmBufRegCallback (mrmBufferInfo *data, mrmBufRecievedCallback callback, void *pass)
	Register data receive callback function. More...

Macro Definition Documentation

BUF_RX

#define BUF_RX   ":BUFRX"

Definition at line 14 of file devMrmBuf.cpp.

BUF_TX

#define BUF_TX   ":BUFTX"

Definition at line 15 of file devMrmBuf.cpp.

Function Documentation

mrmBufDisable()

epicsStatus mrmBufDisable

(

mrmBufferInfo_t *

data

)

Disable buffer sending logic.

Disables data buffer logic for both transfer and receive functionality.

Parameters

data	The buffer information data structure

Returns

Returns 0 on success -1 on failure.

Definition at line 109 of file devMrmBuf.cpp.

                                                 {

    if(data && data->bufRx) {
        data->bufRx->dataRxEnable(false);
    }

    if(data && data->bufTx) {
        data->bufTx->dataTxEnable(false);
    }

    return 0;
}

mrmBufEnable()

epicsStatus mrmBufEnable

(

mrmBufferInfo_t *

data

)

Disable buffer sending logic.

Enables data buffer logic for both transfer and receive functionality. This is already called by the enable record so it is only needed if the records for buffer enabling are not present.

Parameters

data	The buffer information data structure

Returns

Returns 0 on success -1 on failure.

Definition at line 96 of file devMrmBuf.cpp.

                                                {

    if(data && data->bufRx) {
        data->bufRx->dataRxEnable(true);
    }

    if(data && data->bufTx) {
        data->bufTx->dataTxEnable(true);
    }

    return 0;
}

mrmBufInit()

mrmBufferInfo_t* mrmBufInit

(

const char *

dev_name

)

Initialize buffer data structure.

This function allocates and initializes the structure for use with other functions. Device name should correspond to the same name as is used when initializing EVR or EVG device with either mrmEv*SetupVME or mrmEv*SetupPCI functions / iocsh commands.

Parameters

dev_name

The name of the device to use for buffer sending and receiving

Returns

Returns the structure pointer on success and NULL on failure.

Definition at line 24 of file devMrmBuf.cpp.

                                                  {

    mrmBufferInfo_t *data  = NULL;
    mrf::Object *object = NULL;
    std::string bufRxName(dev_name);
    std::string bufTxName(dev_name);

    if(!dev_name) {
        errlogPrintf("mrmBufInit ERROR: NULL device name!\n");
        return NULL;
    }

    if(!(data = (mrmBufferInfo_t *)calloc(1, sizeof(mrmBufferInfo_t)))) {
        errlogPrintf("mrmBufInit ERROR: failed to allocate memory for buffer info!\n");
        return NULL;
    }

    bufRxName += BUF_RX;
    bufTxName += BUF_TX;

    object = mrf::Object::getObject(bufRxName);
    if(!object) {
        errlogPrintf("mrmBufInit WARNING: failed to find object '%s'\n", bufRxName.c_str());
    } else {
        data->bufRx = dynamic_cast<dataBufRx*>(object);
    }

    object = mrf::Object::getObject(bufTxName);
    if(!object) {
        errlogPrintf("mrmBufInit WARNING: failed to find object '%s'\n", bufTxName.c_str());
    } else {
        data->bufTx = dynamic_cast<mrmDataBufTx*>(object);
    }

    if(!data->bufRx && !data->bufTx) {
        errlogPrintf("mrmBufInit: ERROR: failed to find both objects!\n");
        free(data);
        data = NULL;
    }

    return data;
}

mrmBufMaxLen()

epicsStatus mrmBufMaxLen	(	mrmBufferInfo_t *	data,
		epicsUInt32 *	maxLength
	)

Get maximum supported buffer length.

Parameters

data	The buffer information data structure
maxLength	Maximum buffer length in bytes

Returns

Returns 0 on success -1 on failure.

Definition at line 122 of file devMrmBuf.cpp.

                                                                      {

    if(!data->bufTx) {
        errlogPrintf("mrmBufMaxLen: ERROR: transfer structure not initialized!\n");
        return -1;
    }

    try {
        *maxLength = data->bufTx->lenMax();
    } catch(std::exception &e) {
        errlogPrintf("mrmBufMaxLen: EXCEPTION: %s\n", e.what());
        return -1;
    }

    return 0;
}

mrmBufRegCallback()

epicsStatus mrmBufRegCallback	(	mrmBufferInfo_t *	data,
		mrmBufRecievedCallback	callback,
		void *	param
	)

Register data receive callback function.

Parameters

data	The buffer information data structure
callback	Callback function to be registered
param	Parameter which is passed to the calllback when it is executed

Returns

Returns 0 on success -1 on failure.

Definition at line 156 of file devMrmBuf.cpp.

                                                                                                 {

    if(!data->bufRx) {
        errlogPrintf("mrmBufRegCallback: ERROR: receive structure not initialized!\n");
        return -1;
    }

    try {
        data->bufRx->dataRxAddReceive(callback, pass);
    } catch(std::exception &e) {
        errlogPrintf("mrmBufRegCallback: EXCEPTION: %s\n", e.what());
        return -1;
    }

    return 0;
}

mrmBufRxSupported()

epicsStatus mrmBufRxSupported

(

mrmBufferInfo_t *

data

)

Checks whether receive buffer is supported.

Since some devices (EVR or EVG) might only support transfer functionality this function allows you to check whether you can call all receive-related functions for this device.

Parameters

data	The buffer information data structure

Returns

Returns 1 if supported, 0 if not and -1 if data is NULL.

Definition at line 67 of file devMrmBuf.cpp.

                                                     {

    if(!data) {
        errlogPrintf("mrmBufRxSupported ERROR: NULL data parameter!\n");
        return -1;
    }

    if(data->bufRx) {
        return 1;
    }

    return 0;
}

mrmBufSend()

epicsStatus mrmBufSend	(	mrmBufferInfo_t *	data,
		epicsUInt32	len,
		epicsUInt8 *	buf
	)

Send buffer data.

The function blocks until data is sent completely.

Parameters

data	The buffer information data structure
len	Buffer length in bytes
buf	Array of buffer data

Returns

Returns 0 on success -1 on failure.

Definition at line 139 of file devMrmBuf.cpp.

                                                                              {

    if(!data->bufTx) {
        errlogPrintf("mrmBufSend: ERROR: transfer structure not initialized!\n");
        return -1;
    }

    try {
        data->bufTx->dataSend(len, buf);
    } catch(std::exception &e) {
        errlogPrintf("mrmBufSend: EXCEPTION: %s\n", e.what());
        return -1;
    }

    return 0;
}

mrmBufTxSupported()

epicsStatus mrmBufTxSupported

(

mrmBufferInfo_t *

data

)

Checks whether transferring buffer is supported.

Since some devices (EVR or EVG) might only support receive functionality this function allows you to check whether you can call all transfer-related functions for this device.

Parameters

data	The buffer information data structure

Returns

Returns 1 if supported, 0 if not and -1 if data is NULL.

Definition at line 81 of file devMrmBuf.cpp.

                                                     {

    if(!data) {
        errlogPrintf("mrmBufTxSupported ERROR: NULL data parameter!\n");
        return -1;
    }

    if(data->bufTx) {
        return 1;
    }

    return 0;

}