srec.h

Embeded bootloader (rrload by ridgerun) for TI linux based platform v5.36

/*
 * File: srec.h
 *
 * Interface definition of an srec parser. As an example, here is how you
 * might produce a SREC file suitable for download:
 *
 *   $ objcopy -S -O srec vmlinux vmlinux.srec
 *
 *   ..or, perhaps more appropriately, the following:
 *
 *   $ arm-linux-objcopy -S -O srec vmlinux vmlinux.srec
 *
 * See Also
 *   srec.c -- An implementation exposing a srec.h interface.
 *
 * Copyright (C) 2002 RidgeRun, Inc.
 * Author: RidgeRun, Inc  <[e-mail]>
 *
 *  This program is free software; you can redistribute  it and/or modify it
 *  under  the terms of  the GNU General  Public License as published by the
 *  Free Software Foundation;  either version 2 of the  License, or (at your
 *  option) any later version.
 *
 *  THIS  SOFTWARE  IS  PROVIDED  ``AS  IS''  AND   ANY  EXPRESS  OR IMPLIED
 *  WARRANTIES,   INCLUDING, BUT NOT  LIMITED  TO, THE IMPLIED WARRANTIES OF
 *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 *  NO  EVENT  SHALL   THE AUTHOR  BE    LIABLE FOR ANY   DIRECT,  INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 *  NOT LIMITED   TO, PROCUREMENT OF  SUBSTITUTE GOODS  OR SERVICES; LOSS OF
 *  USE, DATA,  OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 *  ANY THEORY OF LIABILITY, WHETHER IN  CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *  You should have received a copy of the  GNU General Public License along
 *  with this program; if not, write  to the Free Software Foundation, Inc.,
 *  675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * Please report all bugs/problems to the author or <[e-mail]>
 *
 * key: RRGPLCR (do not remove)
 *
 */

#ifndef SREC_H
#define SREC_H

#include "types.h"
#include "flash.h"

extern void srec_RegisterGetByte(GetByteCallBack_t CBack);

  // --srec_RegisterGetByte--
  // Allows the caller to register the getchar
  // callback routine that will be used during
  // the processing of a srec_parse().

extern void srec_RegisterPut(PutValAtAddrCallBack_t CBack);

  // --srec_RegisterPut--
  // Allows the caller to register the "put"
  // callback routine that will be used during
  // the processing of a srec_parse().

extern ParseStatus_t srec_parse(unsigned int *load_addr,  // out
                                unsigned int *entry_addr, // out
                                unsigned int *num_bytes); // out
  // --srec_parse--
  // Use srec_parse to process the ascii srec stream
  // and produce a set of Put() calls forming 
  // the address/val pairs necessary to load the
  // incoming image into memory. Uses the caller's
  // supplied GetByte() and PutByte() routines
  // during the processing.
  //
  // Parameters:
  //   These output values are set by the parse operation
  //   and summarize the resulting load to memory.

#endif