librtas_src/common.h File Reference

#include <stdio.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	rtas_operations
struct	librtas_config
Defines
#define	RC_BUSY   -2
#define	EXTENDED_DELAY_MIN   9900
#define	EXTENDED_DELAY_MAX   9905
#define	PAGE_SIZE   4096
#define	dbg(_lvl, _fmt, _args...)
#define	dbg1(_fmt, _args...)
Functions
int	open_proc_rtas_file (const char *name, int mode)
	Open the proc rtas file.
int	rtas_token (const char *call_name)
	Retrive a rtas token for a given name.
int	read_entire_file (int fd, char **buf, size_t *len)
	Read in an entire file into the supplied buffer.
Variables
struct librtas_config	config

---

Detailed Description

Copyright (C) 2005 IBM Corporation Common Public License Version 1.0 (see COPYRIGHT)

Author:

John Rose <johnrose@us.ibm.com>

---

Define Documentation

#define dbg	(	_lvl,
		_fmt,
		_args...		)

Value:

do {                                                            \
                if (config.debug >= _lvl)                               \
                        printf("librtas %s(): " _fmt, __FUNCTION__, ##_args); \
        } while (0)

#define dbg1	(	_fmt,
		_args...		)

Value:

do {                                                            \
                dbg(1, _fmt, ##_args);                                  \
        } while (0)                                                     \

Referenced by acquire_file_lock(), get_phys_region(), handle_delay(), mmap_dev_mem(), munmap_dev_mem(), read_entire_file(), read_kregion_bounds(), release_file_lock(), release_phys_region(), sc_activate_firmware(), sc_cfg_connector(), sc_display_char(), sc_display_msg(), sc_errinjct(), sc_errinjct_close(), sc_errinjct_open(), sc_free_rmo_buffer(), sc_get_config_addr_info2(), sc_get_dynamic_sensor(), sc_get_indices(), sc_get_power_level(), sc_get_rmo_buffer(), sc_get_sensor(), sc_get_sysparm(), sc_get_time(), sc_get_vpd(), sc_lpar_perftools(), sc_platform_dump(), sc_read_slot_reset(), sc_rtas_call(), sc_scan_log_dump(), sc_set_dynamic_indicator(), sc_set_eeh_option(), sc_set_indicator(), sc_set_power_level(), sc_set_poweron_time(), sc_set_sysparm(), sc_set_time(), sc_suspend_me(), sc_update_nodes(), and sc_update_properties().

#define EXTENDED_DELAY_MAX   9905

Referenced by handle_delay().

#define EXTENDED_DELAY_MIN   9900

Referenced by handle_delay().

#define PAGE_SIZE   4096

Referenced by get_phys_region(), pfs_cfg_connector(), pfs_get_sysparm(), read_kregion_bounds(), release_phys_region(), sc_cfg_connector(), sc_free_rmo_buffer(), sc_get_rmo_buffer(), sc_get_vpd(), sc_lpar_perftools(), sc_update_nodes(), and sc_update_properties().

#define RC_BUSY   -2

Referenced by handle_delay().

---

Function Documentation

int open_proc_rtas_file	(	const char *	name,
		int	mode
	)

open_proc_rtas_file

Parameters:

	name	filename to open
	mode	mode to open file in

Returns:

results of open() call

Referenced by do_rtas_op(), procfs_interface_exists(), read_kregion_bounds(), and sc_interface_exists().

int read_entire_file	(	int	fd,
		char **	buf,
		size_t *	len
	)

read_entire_file

Parameters:

	fd	opened file descriptor for file to read
	buf	buffer to read file into
	len	variable to return amount read into buffer

Returns:

0 on success, !0 otherwise

References BLOCK_SIZE, and dbg1.

Referenced by get_property(), and read_kregion_bounds().

int rtas_token

(

const char *

call_name

)

rtas_token

Parameters:

call_name

rtas name to retrieve token for

Returns:

0 on success, !0 otherwise

References get_property(), ofdt_rtas_path, and RTAS_UNKNOWN_OP.

---

Variable Documentation

struct librtas_config config

Referenced by display_rtas_buf(), handle_delay(), and sc_delay_timeout().