image_download_primecell.c

QNX ADS BSP code for i.MX27 chips

/*
 * $QNXLicenseC: 
 * Copyright 2007, QNX Software Systems.  
 *  
 * Licensed under the Apache License, Version 2.0 (the "License"). You  
 * may not reproduce, modify or distribute this software except in  
 * compliance with the License. You may obtain a copy of the License  
 * at: http://www.apache.org/licenses/LICENSE-2.0  
 *  
 * Unless required by applicable law or agreed to in writing, software  
 * distributed under the License is distributed on an "AS IS" basis,  
 * WITHOUT WARRANTIES OF ANY KIND, either express or implied. 
 * 
 * This file may contain contributions from others, either as  
 * contributors under the License or as licensors under other terms.   
 * Please review this entire file for other proprietary rights or license  
 * notices, as well as the QNX Development Suite License Guide at  
 * http://licensing.qnx.com/license-guide/ for other information. 
 * $ 
 */



#include "ipl.h"
#include <hw/inout.h>
#include <arm/primecell.h>
#include <inttypes.h>

typedef struct	data_record {
	uint8_t	cmd;
	uint8_t	seq;
	uint8_t	cksum;
	uint8_t	nbytes;
	long	daddr;
} data_record_t;

#define DATA_RECORD_HEADER		8

#define	START_CMD				0x80
#define	DATA_CMD				0x81
#define	GO_CMD				    0x82
#define	ECHO_CMD				0x83
#define	ABORT_CMD				0x88

#define	ABORT_CKSUM				1
#define	ABORT_SEQ				2
#define	ABORT_PROTOCOL		    3

/*
 *	user defined defaults
 */
#define	DEFAULT_CLK				14745600

unsigned	primecell_uart;

void
init_primecell(unsigned port, unsigned baud, unsigned clk)
{
#ifdef	NEEDS_LIBGCC
	/*
	 * Calculate baud rate divisor. H/W fixes divide by 16.
	 */
	if (clk == 0) {
		clk = DEFAULT_CLK;
	}
	baud = (clk / (16 * baud)) - 1;
#else
	/*
	 * Values assume DEFAULT_CLK
	 */
	switch (baud) {
	case 115200:	baud = 7;	break;
	case 57600:		baud = 15;	break;
	case 38400:		baud = 23;	break;
	case 19200:		baud = 47;	break;
	case 9600:		baud = 95;	break;
	}
#endif

	/*
	 * Disable uart and program baud rate divisor
	 */
	out32(port + PRIMECELL_UART_CR, 0);
	out32(port + PRIMECELL_UART_LCRL, baud & 0xff);
	out32(port + PRIMECELL_UART_LCRM, (baud >> 8) & 0xff);

	/*
	 * Set 8bit, no-parity, 1 stop bit and enable FIFO
	 */
	out32(port + PRIMECELL_UART_LCRH, PRIMECELL_UART_LCRH_8BIT
									| PRIMECELL_UART_LCRH_FEN);

	/*
	 * Clear status and error bits
	 */
	out32(port + PRIMECELL_UART_ICR, 0);
	out32(port + PRIMECELL_UART_ECR, 0);

	/*
	 * Enable UART
	 */
	out32(port + PRIMECELL_UART_CR, PRIMECELL_UART_CR_UARTEN);
	primecell_uart = port;
}


unsigned char
get_byte_primecell()
{
	unsigned port = primecell_uart;

	while ((in32(port + PRIMECELL_UART_FR) & PRIMECELL_UART_FR_RXFE) != 0)
		;
	return in32(port + PRIMECELL_UART_DR);
}

void
put_byte_primecell(unsigned char data)
{
	unsigned port = primecell_uart;

	while ((in32(port + PRIMECELL_UART_FR) & PRIMECELL_UART_FR_TXFF) != 0)
		;
	out32(port + PRIMECELL_UART_DR, data);
}


void
abort_cmd_primecell(char abort)
{
	put_byte_primecell(ABORT_CMD);
	put_byte_primecell(abort);
}

unsigned
image_download_primecell(unsigned dst_address)
{
	char			seq=0;
	int				i;
	data_record_t	record;
	char 			*src;
	char			*dst;	

	/*
	 * set destination address within memory
	 */
	dst = (char *)dst_address;

	/*
	 * Wait for initial start record
	 */
	while (get_byte_primecell() != START_CMD)
		;

	while (1) {
		/*
		 * start processing the data/go records
		 */
		record.cmd = get_byte_primecell();
		if (record.cmd != DATA_CMD) {
			/*
			 * check for a GO cmd to return control to the IPL
			 */
			if (record.cmd == GO_CMD) 	
				return(0);

			abort_cmd_primecell(ABORT_PROTOCOL);
			return(1);
		}
		

		/*
		 *	read data_record header
		 *  (DATA_RECORD_HEADER -1 since cmd already consumed by get_byte)
		 */
	    src = &record.seq;

		for (i = 0; i < (DATA_RECORD_HEADER - 1) ; i++) {
			*src = get_byte_primecell();
			src++;
		}
			
		if (seq != record.seq) {
			abort_cmd_primecell(ABORT_SEQ);
			return(1);
		}
		else {
			seq = (seq + 1) & 0x7f;
		}

		/*
		 * Get rest of data
		 */
		for (i = 0; i <= record.nbytes; i++) {
            *dst = get_byte_primecell();
			dst++;
		}
	}
}


void
debug_char_primecell(char c)
{
	if (c == '\n')
		put_byte_primecell('\r');
	put_byte_primecell(c);
}

void
debug_string_primecell(const char *str)
{
	while (*str) {
		debug_char_primecell(*str++);
	}
}

void
debug_hex_primecell(unsigned x)
{
	int					i;
	char				buf[9];
	static const char	hex[] = "0123456789ABCDEF";

	for (i = 0; i < 8; i++) {
		buf[7-i] = hex[x & 15];
		x >>= 4;
	}
	buf[8] = '\0';
	debug_string_primecell(buf);
}