/usr/include/freeipmi/driver/ipmi-kcs-driver.h is in libfreeipmi-dev 1.4.11-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | /*
* Copyright (C) 2003-2014 FreeIPMI Core Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef IPMI_KCS_DRIVER_H
#define IPMI_KCS_DRIVER_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <freeipmi/fiid/fiid.h>
#define IPMI_KCS_SMS_IO_BASE_DEFAULT 0x0CA2
#define IPMI_KCS_ERR_SUCCESS 0
#define IPMI_KCS_ERR_NULL 1
#define IPMI_KCS_ERR_INVALID 2
#define IPMI_KCS_ERR_PARAMETERS 3
#define IPMI_KCS_ERR_PERMISSION 4
#define IPMI_KCS_ERR_IO_NOT_INITIALIZED 5
#define IPMI_KCS_ERR_OVERFLOW 6
#define IPMI_KCS_ERR_BUSY 7
#define IPMI_KCS_ERR_OUT_OF_MEMORY 8
#define IPMI_KCS_ERR_DEVICE_NOT_FOUND 9
#define IPMI_KCS_ERR_DRIVER_TIMEOUT 10
#define IPMI_KCS_ERR_IPMI_ERROR 11
#define IPMI_KCS_ERR_SYSTEM_ERROR 12
#define IPMI_KCS_ERR_INTERNAL_ERROR 13
#define IPMI_KCS_ERR_ERRNUMRANGE 14
/* NONBLOCKING - if busy, IPMI_KCS_ERR_BUSY will be returned.
*
* SPIN_POLL - when polling, internally spin instead of putting
* process to sleep. If polling intervals are small, may improve
* inband performance by removing context switches and OS timer
* granularity.
*/
#define IPMI_KCS_FLAGS_DEFAULT 0x00000000
#define IPMI_KCS_FLAGS_NONBLOCKING 0x00000001
#define IPMI_KCS_FLAGS_SPIN_POLL 0x00000002
typedef struct ipmi_kcs_ctx *ipmi_kcs_ctx_t;
ipmi_kcs_ctx_t ipmi_kcs_ctx_create (void);
void ipmi_kcs_ctx_destroy (ipmi_kcs_ctx_t ctx);
int ipmi_kcs_ctx_errnum (ipmi_kcs_ctx_t ctx);
char *ipmi_kcs_ctx_strerror (int errnum);
char *ipmi_kcs_ctx_errormsg (ipmi_kcs_ctx_t ctx);
int ipmi_kcs_ctx_get_driver_address (ipmi_kcs_ctx_t ctx, uint16_t *bmc_iobase_address);
int ipmi_kcs_ctx_get_register_spacing (ipmi_kcs_ctx_t ctx, uint8_t *register_spacing);
int ipmi_kcs_ctx_get_poll_interval (ipmi_kcs_ctx_t ctx, uint8_t *poll_interval);
int ipmi_kcs_ctx_get_flags (ipmi_kcs_ctx_t ctx, unsigned int *flags);
int ipmi_kcs_ctx_set_driver_address (ipmi_kcs_ctx_t ctx, uint16_t bmc_iobase_address);
int ipmi_kcs_ctx_set_register_spacing (ipmi_kcs_ctx_t ctx, uint8_t register_spacing);
int ipmi_kcs_ctx_set_poll_interval (ipmi_kcs_ctx_t ctx, uint8_t poll_interval);
int ipmi_kcs_ctx_set_flags (ipmi_kcs_ctx_t ctx, unsigned int flags);
int ipmi_kcs_ctx_io_init (ipmi_kcs_ctx_t ctx);
/* returns length written on success, -1 on error */
int ipmi_kcs_write (ipmi_kcs_ctx_t ctx,
const void *buf,
unsigned int buf_len);
/* returns length read on success, -1 on error */
int ipmi_kcs_read (ipmi_kcs_ctx_t ctx,
void *buf,
unsigned int buf_len);
int ipmi_kcs_cmd (ipmi_kcs_ctx_t ctx,
uint8_t lun,
uint8_t net_fn,
fiid_obj_t obj_cmd_rq,
fiid_obj_t obj_cmd_rs);
#ifdef __cplusplus
}
#endif
#endif /* IPMI_KCS_DRIVER_H */
|