svf2csvf.h

/*
 * Copyright (C) 2009-2012 Chris McClelland
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef SVF2CSVF_H
#define SVF2CSVF_H

#include <libbuffer.h>
#include "libfpgalink.h"

#ifdef __cplusplus
extern "C" {
#endif

	struct BitStore {
		uint32 numBits;
		struct Buffer tdi;
		struct Buffer tdo;
		struct Buffer mask;
		// TODO: smask?
	};
	struct ParseContext {
		struct BitStore dataHead;
		struct BitStore insnHead;
		struct BitStore dataBody;
		struct BitStore insnBody;
		struct BitStore dataTail;
		struct BitStore insnTail;
		uint32 curLength;
		struct Buffer curMaskBuf;
		uint32 curMaskBits;
		uint32 lastCmdOffset;
		uint32 lastRunTestOffset;
		uint32 lastRunTestValue;
	};

	#define bitsToBytes(x) (((x)>>3) + ((x)&7 ? 1 : 0))
	#define CHOMP() while ( *p == ' ' || *p == '\t' || *p == '\r' ) { p++; }
	
	FLStatus headTail(
		struct Buffer *dataBuf, struct Buffer *hdrBuf, struct Buffer *tailBuf,
		uint32 dataBits, uint32 hdrBits, uint32 tailBits,
		const char **error
	) WARN_UNUSED_RESULT;
	
	FLStatus readBytes(
		struct Buffer *buffer, const char *hexDigits, const char **error
	) WARN_UNUSED_RESULT;
	
	FLStatus cxtInitialise(
		struct ParseContext *cxt, const char **error
	) WARN_UNUSED_RESULT;
	
	void cxtDestroy(
		struct ParseContext *cxt);
	
	FLStatus parseLine(
		struct ParseContext *cxt, const struct Buffer *lineBuf, struct Buffer *csvfBuf,
		uint32 *maxBufSize, const char **error
	) WARN_UNUSED_RESULT;

	FLStatus insertRunTestBefore(
		struct Buffer *buf, uint32 offset, uint32 count,
		uint32 *lastRunTestOffset, uint32 *lastRunTestValue,
		const char **error
	) WARN_UNUSED_RESULT;

#ifdef __cplusplus
}
#endif

#endif