oshi.util.platform.mac

Class SmcUtil

java.lang.Object

oshi.util.platform.mac.SmcUtil

public class SmcUtil
extends Object

Provides access to SMC calls on OS X

Author:

widdis[at]gmail[dot]com

Method Summary

Modifier and Type	Method and Description
static int	smcCall(int index, IOKit.SMCKeyData inputStructure, IOKit.SMCKeyData outputStructure) Call SMC
static int	smcClose() Close connection to SMC
static float	smcGetFpe2(String key, int retries) Get a value from SMC which is in FPE2 datatype.
static int	smcGetKeyInfo(IOKit.SMCKeyData inputStructure, IOKit.SMCKeyData outputStructure) Get cached keyInfo if it exists, or generate new keyInfo
static long	smcGetLong(String key, int retries) Get a 64-bit integer value from SMC
static double	smcGetSp78(String key, int retries) Get a value from SMC which is in SP78 datatype (used for Temperature) First bit is sign, next 7 bits are integer portion, last 8 bits are fractional portion
static int	smcOpen() Open a connection to SMC
static int	smcReadKey(String key, IOKit.SMCVal val, int retries) Read a key from SMC

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

smcOpen

public static int smcOpen()

Open a connection to SMC

Returns:

0 if successful, nonzero if failure

smcClose

public static int smcClose()

Close connection to SMC

Returns:

0 if successful, nonzero if failure

smcGetSp78

public static double smcGetSp78(String key,
                                int retries)

Get a value from SMC which is in SP78 datatype (used for Temperature) First bit is sign, next 7 bits are integer portion, last 8 bits are fractional portion

Parameters:

key - The key to retrieve

retries - Number of times to retry the key

Returns:

Double representing the value

smcGetLong

public static long smcGetLong(String key,
                              int retries)

Get a 64-bit integer value from SMC

Parameters:

key - The key to retrieve

retries - Number of times to retry the key

Returns:

Long representing the value

smcGetFpe2

public static float smcGetFpe2(String key,
                               int retries)

Get a value from SMC which is in FPE2 datatype. First E (14) bits are unsigned integer portion, Last 2 bits are fractional portion

Parameters:

key - The key to retrieve

retries - Number of times to retry the key

Returns:

Float representing the value

smcGetKeyInfo

public static int smcGetKeyInfo(IOKit.SMCKeyData inputStructure,
                                IOKit.SMCKeyData outputStructure)

Get cached keyInfo if it exists, or generate new keyInfo

Parameters:

inputStructure - Key data input

outputStructure - Key data output

Returns:

0 if successful, nonzero if failure

smcReadKey

public static int smcReadKey(String key,
                             IOKit.SMCVal val,
                             int retries)

Read a key from SMC

Parameters:

key - Key to read

val - Structure to receive the result

retries - Number of attempts to try

Returns:

0 if successful, nonzero if failure

smcCall

public static int smcCall(int index,
                          IOKit.SMCKeyData inputStructure,
                          IOKit.SMCKeyData outputStructure)

Call SMC

Parameters:

index - Kernel index

inputStructure - Key data input

outputStructure - Key data output

Returns:

0 if successful, nonzero if failure