Subversion Repositories openrisc_2011-10-31

// ----------------------------------------------------------------------------

// RSP packet: definition

// Copyright (C) 2008  Embecosm Limited <info@embecosm.com>

// Contributor Jeremy Bennett <jeremy.bennett@embecosm.com>

// This file is part of the cycle accurate model of the OpenRISC 1000 based

// system-on-chip, ORPSoC, built using Verilator.

// 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/>.

// ----------------------------------------------------------------------------

// $Id: RspPacket.h 326 2009-03-07 16:47:31Z jeremy $

#ifndef RSP_PACKET__H

#define RSP_PACKET__H

#include <iostream>

//-----------------------------------------------------------------------------

//! Class for RSP packets

//! Can't be null terminated, since it may include zero bytes

//-----------------------------------------------------------------------------

class RspPacket

{

public:

  //! The data buffer. Allow direct access to avoid unnecessary copying.

  char *data;

  // Constructor and destructor

  RspPacket (int  _bufSize);

  ~RspPacket ();

  // Pack a constant string into a packet

  void  packStr (const char *str);      // For fixed packets

  // Accessors

  int   getBufSize ();

  int   getLen ();

  void  setLen (int  _len);

private:

  //! The data buffer size

  int   bufSize;

  //! Number of chars in the data buffer (<= bufSize)

  int   len;

};

//! Stream output

std::ostream &operator<< (std::ostream &s,

                          RspPacket    &p);

#endif  // RSP_PACKET_SC__H