OpenCores
URL https://opencores.org/ocsvn/funbase_ip_library/funbase_ip_library/trunk

Subversion Repositories funbase_ip_library

[/] [funbase_ip_library/] [trunk/] [TUT/] [ip.swp.api/] [openmcapi/] [1.0/] [libmcapi/] [mcapi/] [data_avail.c] - Blame information for rev 145

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 145 lanttu
/*
2
 * Copyright (c) 2010, Mentor Graphics Corporation
3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions are met:
7
 *
8
 * 1. Redistributions of source code must retain the above copyright notice,
9
 *    this list of conditions and the following disclaimer.
10
 * 2. Redistributions in binary form must reproduce the above copyright notice,
11
 *    this list of conditions and the following disclaimer in the documentation
12
 *    and/or other materials provided with the distribution.
13
 * 3. Neither the name of the <ORGANIZATION> nor the names of its contributors
14
 *    may be used to endorse or promote products derived from this software
15
 *    without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
 * POSSIBILITY OF SUCH DAMAGE.
28
 */
29
 
30
 
31
 
32
#include <openmcapi.h>
33
 
34
/*************************************************************************
35
*
36
*   FUNCTION
37
*
38
*       mcapi_data_available
39
*
40
*   DESCRIPTION
41
*
42
*       Non-blocking API routine to check for data on an endpoint.
43
*
44
*   INPUTS
45
*
46
*       *rx_endp_ptr            A pointer to the endpoint being checked
47
*                               for data.
48
*       type                    The type of channel; packet or scalar.
49
*       *msg_count              A pointer to the number of receive calls
50
*                               that will complete without blocking.
51
*       *mcapi_status           A pointer to memory that will be filled in
52
*                               with the status of the call.
53
*
54
*   OUTPUTS
55
*
56
*       The number of receive operations that are guaranteed to not block
57
*       waiting for incoming data.
58
*
59
*************************************************************************/
60
void mcapi_data_available(MCAPI_ENDPOINT *rx_endp_ptr, mcapi_uint32_t type,
61
                          mcapi_uint_t *msg_count,
62
                          mcapi_status_t *mcapi_status)
63
{
64
    /* Validate the status parameter. */
65
    if (mcapi_status)
66
    {
67
        /* Ensure this is a receive handle. */
68
        if (rx_endp_ptr->mcapi_state & MCAPI_ENDP_RX)
69
        {
70
            /* Check if the endpoint is connected. */
71
            if (rx_endp_ptr->mcapi_state & MCAPI_ENDP_CONNECTED)
72
            {
73
                /* Ensure this is a macthing channel type. */
74
                if (rx_endp_ptr->mcapi_chan_type == type)
75
                {
76
                    /* Count the number of packets on the channel. */
77
                    mcapi_check_data(rx_endp_ptr, msg_count);
78
 
79
                    /* The return value is success whether there is data
80
                     * on the endpoint or not.
81
                     */
82
                    *mcapi_status = MCAPI_SUCCESS;
83
                }
84
 
85
                /* This is a scalar channel. */
86
                else
87
                {
88
                    *mcapi_status = MCAPI_ERR_CHAN_TYPE;
89
                }
90
            }
91
 
92
            /* The connection has not been made yet. */
93
            else
94
            {
95
                *mcapi_status = MGC_MCAPI_ERR_NOT_CONNECTED;
96
            }
97
        }
98
 
99
        /* Data cannot be received on a send handle. */
100
        else if (rx_endp_ptr->mcapi_state & MCAPI_ENDP_TX)
101
        {
102
            *mcapi_status = MCAPI_ERR_CHAN_DIRECTION;
103
        }
104
 
105
        /* The receive handle has been closed. */
106
        else
107
        {
108
            *mcapi_status = MCAPI_ERR_CHAN_INVALID;
109
        }
110
    }
111
 
112
}
113
 

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.