| 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_get_endpoint_attribute
|
| 39 |
|
|
*
|
| 40 |
|
|
* DESCRIPTION
|
| 41 |
|
|
*
|
| 42 |
|
|
* API routine to retrieve attributes specific to a local endpoint.
|
| 43 |
|
|
*
|
| 44 |
|
|
* INPUTS
|
| 45 |
|
|
*
|
| 46 |
|
|
* endpoint The endpoint identifier on the local node
|
| 47 |
|
|
* of which to obtain the attribute.
|
| 48 |
|
|
* attribute_num The attribute to retrieve.
|
| 49 |
|
|
* *attribute A pointer to memory that will be filled in
|
| 50 |
|
|
* with the value of the respective attribute.
|
| 51 |
|
|
* attribute_size The number of bytes allocated for *attribute.
|
| 52 |
|
|
* *mcapi_status A pointer to memory that will be filled in
|
| 53 |
|
|
* with the status of the call.
|
| 54 |
|
|
*
|
| 55 |
|
|
* OUTPUTS
|
| 56 |
|
|
*
|
| 57 |
|
|
* None.
|
| 58 |
|
|
*
|
| 59 |
|
|
*************************************************************************/
|
| 60 |
|
|
void mcapi_get_endpoint_attribute(mcapi_endpoint_t endpoint,
|
| 61 |
|
|
mcapi_uint_t attribute_num, void *attribute,
|
| 62 |
|
|
size_t attribute_size,
|
| 63 |
|
|
mcapi_status_t *mcapi_status)
|
| 64 |
|
|
{
|
| 65 |
|
|
MCAPI_GLOBAL_DATA *node_data;
|
| 66 |
|
|
MCAPI_ENDPOINT *endp_ptr;
|
| 67 |
|
|
mcapi_node_t node_id;
|
| 68 |
|
|
mcapi_port_t port_id;
|
| 69 |
|
|
|
| 70 |
|
|
/* Validate mcapi_status input parameter. */
|
| 71 |
|
|
if (mcapi_status)
|
| 72 |
|
|
{
|
| 73 |
|
|
/* Validate attribute input parameter. */
|
| 74 |
|
|
if (attribute)
|
| 75 |
|
|
{
|
| 76 |
|
|
/* Get the lock. */
|
| 77 |
|
|
mcapi_lock_node_data();
|
| 78 |
|
|
|
| 79 |
|
|
/* Get a pointer to the global node list. */
|
| 80 |
|
|
node_data = mcapi_get_node_data();
|
| 81 |
|
|
|
| 82 |
|
|
/* Get a pointer to the endpoint. */
|
| 83 |
|
|
endp_ptr = mcapi_decode_local_endpoint(node_data, &node_id, &port_id,
|
| 84 |
|
|
endpoint, mcapi_status);
|
| 85 |
|
|
|
| 86 |
|
|
/* Ensure the endpoint is valid. */
|
| 87 |
|
|
if (*mcapi_status == MCAPI_SUCCESS)
|
| 88 |
|
|
{
|
| 89 |
|
|
switch (attribute_num)
|
| 90 |
|
|
{
|
| 91 |
|
|
case MCAPI_ATTR_ENDP_PRIO:
|
| 92 |
|
|
|
| 93 |
|
|
/* If the priority will fit in the buffer. */
|
| 94 |
|
|
if (attribute_size >= sizeof(endp_ptr->mcapi_priority))
|
| 95 |
|
|
{
|
| 96 |
|
|
/* Return the priority. */
|
| 97 |
|
|
*(mcapi_uint32_t*)attribute = endp_ptr->mcapi_priority;
|
| 98 |
|
|
|
| 99 |
|
|
*mcapi_status = MCAPI_SUCCESS;
|
| 100 |
|
|
}
|
| 101 |
|
|
|
| 102 |
|
|
/* The buffer is too small to store the value. */
|
| 103 |
|
|
else
|
| 104 |
|
|
{
|
| 105 |
|
|
*mcapi_status = MCAPI_ERR_ATTR_SIZE;
|
| 106 |
|
|
}
|
| 107 |
|
|
|
| 108 |
|
|
break;
|
| 109 |
|
|
|
| 110 |
|
|
default:
|
| 111 |
|
|
|
| 112 |
|
|
/* If there is a route associated with the endpoint. */
|
| 113 |
|
|
if (endp_ptr->mcapi_route)
|
| 114 |
|
|
{
|
| 115 |
|
|
/* If there is an interfae associated with the
|
| 116 |
|
|
* route.
|
| 117 |
|
|
*/
|
| 118 |
|
|
if (endp_ptr->mcapi_route->mcapi_rt_int)
|
| 119 |
|
|
{
|
| 120 |
|
|
/* Call the interface-specific ioctl command. */
|
| 121 |
|
|
*mcapi_status =
|
| 122 |
|
|
endp_ptr->mcapi_route->mcapi_rt_int->mcapi_ioctl(attribute_num,
|
| 123 |
|
|
attribute,
|
| 124 |
|
|
attribute_size);
|
| 125 |
|
|
}
|
| 126 |
|
|
}
|
| 127 |
|
|
|
| 128 |
|
|
else
|
| 129 |
|
|
{
|
| 130 |
|
|
/* We don't know what interface to query. */
|
| 131 |
|
|
*mcapi_status = MGC_MCAPI_ERR_NOT_CONNECTED;
|
| 132 |
|
|
}
|
| 133 |
|
|
|
| 134 |
|
|
break;
|
| 135 |
|
|
}
|
| 136 |
|
|
}
|
| 137 |
|
|
|
| 138 |
|
|
/* Release the lock. */
|
| 139 |
|
|
mcapi_unlock_node_data();
|
| 140 |
|
|
}
|
| 141 |
|
|
|
| 142 |
|
|
/* The pointer for attribute is invalid. */
|
| 143 |
|
|
else
|
| 144 |
|
|
{
|
| 145 |
|
|
*mcapi_status = MCAPI_ERR_PARAMETER;
|
| 146 |
|
|
}
|
| 147 |
|
|
}
|
| 148 |
|
|
|
| 149 |
|
|
}
|
