PipeStream.h

Go to the documentation of this file.

/*
 * @brief Pipe data stream transmission and reception management
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * Copyright(C) Dean Camera, 2011, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __PIPE_STREAM_H__
#define __PIPE_STREAM_H__

 /* Includes: */
  #include "../../../Common/Common.h"
  #include "USBMode.h"
  
 /* Enable C linkage for C++ Compilers: */
  #if defined(__cplusplus)
   extern "C" {
  #endif

 /* Preprocessor Checks: */
  #if !defined(__INCLUDE_FROM_USB_DRIVER)
   #error Do not include this file directly. Include lpcroot/libraries/LPCUSBlib/Drivers/USB/USB.h instead.
  #endif
  
 /* Public Interface - May be used in end-application: */
  /* Enums: */
   enum Pipe_Stream_RW_ErrorCodes_t
   {
    PIPE_RWSTREAM_NoError            = 0, 
    PIPE_RWSTREAM_PipeStalled        = 1, 
    PIPE_RWSTREAM_DeviceDisconnected = 2, 
    PIPE_RWSTREAM_Timeout            = 3, 
    PIPE_RWSTREAM_IncompleteTransfer = 4, 
   };

  #include "USBTask.h"
  /* Function Prototypes: */
  uint8_t Pipe_Discard_Stream(const uint8_t corenum,
         uint16_t Length,
         uint16_t *const BytesProcessed) /*ATTR_DEPRECATED*/;

  uint8_t Pipe_Null_Stream(const uint8_t corenum,
         uint16_t Length,
         uint16_t *const BytesProcessed);


  uint8_t Pipe_Write_Stream_LE(const uint8_t corenum,
          const void *const Buffer,
          uint16_t Length,
          uint16_t *const BytesProcessed);

  uint8_t Pipe_Write_Stream_BE(const void *const Buffer,
          uint16_t Length,
          uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
   "Function is not implemented yet");

  uint8_t Pipe_Read_Stream_LE(const uint8_t corenum,
         void *const Buffer,
         uint16_t Length,
         uint16_t *const BytesProcessed);

  uint8_t Pipe_Read_Stream_BE(void *const Buffer,
         uint16_t Length,
         uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
   "Function is not implemented yet");

  uint8_t Pipe_Write_EStream_LE(const void *const Buffer,
           uint16_t Length,
           uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
   "Function is not implemented yet");

  uint8_t Pipe_Write_EStream_BE(const void *const Buffer,
           uint16_t Length,
           uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
   "Function is not implemented yet");

  uint8_t Pipe_Read_EStream_LE(void *const Buffer,
          uint16_t Length,
          uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
   "Function is not implemented yet");

  uint8_t Pipe_Read_EStream_BE(void *const Buffer,
          uint16_t Length,
          uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
   "Function is not implemented yet");


  uint8_t Pipe_Write_PStream_LE(const void *const Buffer,
           uint16_t Length,
           uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
   "Function is not implemented yet");

  uint8_t Pipe_Write_PStream_BE(const void *const Buffer,
           uint16_t Length,
           uint16_t *const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1) ATTR_ERROR(
   "Function is not implemented yet");
   
   uint8_t Pipe_Streaming(uint8_t corenum, uint8_t* const buffer, uint32_t const transferlength, uint16_t const packetsize);
   

 /* Disable C linkage for C++ Compilers: */
  #if defined(__cplusplus)
   }
  #endif
 
#endif