Emulex Logo
OneCoreā„¢ Storage SDK Release 11.2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
elxu_lancer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2015, Emulex
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  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  */
32 
33 #if !defined(__ELXU_LANCER_H__)
34 #define __ELXU_LANCER_H__
35 
36 #include <elxu_device.h>
37 
38 typedef struct sli4_object_s {
39  struct sli4_object_s *next;
40  char *name;
41  uint32_t type;
42  uint32_t length;
44 
45 
46 extern sli4_object_t *sli4_object_new(const char *name, uint32_t type, uint32_t length);
47 extern void sli4_object_free(sli4_object_t *obj);
48 extern void sli4_object_free_list(sli4_object_t *head);
50 extern int sli4_object_delete (elxu_device_t *device, const char *objectName);
51 extern int sli4_object_read(elxu_device_t *device, const char *objectName, void *buffer, uint32_t bufferLength);
52 extern int sli4_object_write (elxu_device_t *device, const char *objectName, int buffer_offset, void *buffer, uint32_t bufferLength, int eofl);
53 extern int sli4_object_length(elxu_device_t *device, const char *objectName);
54 #endif // __ELXU_LANCER_H__
55 
sli4_object_t * sli4_object_new(const char *name, uint32_t type, uint32_t length)
Instantiate a new sli4_object_t.
Definition: elxu_lancer.c:533
void sli4_object_free(sli4_object_t *obj)
Free and sli4_object_t.
Definition: elxu_lancer.c:553
int sli4_object_read(elxu_device_t *device, const char *objectName, void *buffer, uint32_t bufferLength)
Read data from an object.
Definition: elxu_lancer.c:333
int sli4_object_write(elxu_device_t *device, const char *objectName, int buffer_offset, void *buffer, uint32_t bufferLength, int eofl)
Write data into an object.
Definition: elxu_lancer.c:429
uint32_t type
Definition: elxu_lancer.h:41
int sli4_object_delete(elxu_device_t *device, const char *objectName)
Deletes an SLI4 object.
Definition: elxu_lancer.c:214
int sli4_object_length(elxu_device_t *device, const char *objectName)
Return an SLI4 object&#39;s length in bytes.
Definition: elxu_lancer.c:271
sli4_object_t * sli4_object_enumerate(elxu_device_t *device)
Create a list of all SLI4 objects.
Definition: elxu_lancer.c:53
uint32_t length
Definition: elxu_lancer.h:42
struct sli4_object_s * next
Definition: elxu_lancer.h:39
void sli4_object_free_list(sli4_object_t *head)
Free a list of sli4_object_t&#39;s.
Definition: elxu_lancer.c:570