Classes | Defines | Typedefs | Enumerations | Functions
cheetah.h File Reference
#include <stdint.h>
Include dependency graph for cheetah.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  CheetahExt
struct  CheetahVersion

Defines

#define CH_DEBUG   0
#define CH_HEADER_VERSION   0x0300 /* v3.00 */
#define CH_HOST_IFCE_FULL_SPEED   0x00
#define CH_HOST_IFCE_HIGH_SPEED   0x01
#define CH_PORT_NOT_FREE   0x8000
#define CH_TARGET_POWER_OFF   0x00
#define CH_TARGET_POWER_ON   0x01
#define CH_TARGET_POWER_QUERY   0x80

Typedefs

typedef int Cheetah
typedef struct CheetahExt CheetahExt
typedef enum CheetahSpiBitorder CheetahSpiBitorder
typedef enum CheetahSpiPhase CheetahSpiPhase
typedef enum CheetahSpiPolarity CheetahSpiPolarity
typedef enum CheetahStatus CheetahStatus
typedef struct CheetahVersion CheetahVersion

Enumerations

enum  CheetahSpiBitorder { CH_SPI_BITORDER_MSB = 0, CH_SPI_BITORDER_LSB = 1 }
enum  CheetahSpiPhase { CH_SPI_PHASE_SAMPLE_SETUP = 0, CH_SPI_PHASE_SETUP_SAMPLE = 1 }
enum  CheetahSpiPolarity { CH_SPI_POL_RISING_FALLING = 0, CH_SPI_POL_FALLING_RISING = 1 }
enum  CheetahStatus {
  CH_OK = 0, CH_UNABLE_TO_LOAD_LIBRARY = -1, CH_UNABLE_TO_LOAD_DRIVER = -2, CH_UNABLE_TO_LOAD_FUNCTION = -3,
  CH_INCOMPATIBLE_LIBRARY = -4, CH_INCOMPATIBLE_DEVICE = -5, CH_INCOMPATIBLE_DRIVER = -6, CH_COMMUNICATION_ERROR = -7,
  CH_UNABLE_TO_OPEN = -8, CH_UNABLE_TO_CLOSE = -9, CH_INVALID_HANDLE = -10, CH_CONFIG_ERROR = -11,
  CH_UNKNOWN_PROTOCOL = -12, CH_STILL_ACTIVE = -13, CH_FUNCTION_NOT_AVAILABLE = -14, CH_OS_ERROR = -15,
  CH_SPI_WRITE_ERROR = -100, CH_SPI_BATCH_EMPTY_QUEUE = -101, CH_SPI_BATCH_SHORT_BUFFER = -102, CH_SPI_ASYNC_EMPTY = -103,
  CH_SPI_ASYNC_PENDING = -104, CH_SPI_ASYNC_MAX_REACHED = -105, CH_SPI_ASYNC_EXCESS_DELAY = -106
}

Functions

int ch_close (Cheetah cheetah)
int ch_dev_addr (Cheetah cheetah)
int ch_find_devices (int num_devices, u16 *devices)
int ch_find_devices_ext (int num_devices, u16 *devices, int num_ids, u32 *unique_ids)
int ch_host_ifce_speed (Cheetah cheetah)
Cheetah ch_open (int port_number)
Cheetah ch_open_ext (int port_number, CheetahExt *ch_ext)
int ch_port (Cheetah cheetah)
u32 ch_sleep_ms (u32 milliseconds)
int ch_spi_async_collect (Cheetah cheetah, int num_bytes, u08 *data_in)
int ch_spi_async_submit (Cheetah cheetah)
int ch_spi_batch_length (Cheetah cheetah)
int ch_spi_batch_shift (Cheetah cheetah, int num_bytes, u08 *data_in)
int ch_spi_bitrate (Cheetah cheetah, int bitrate_khz)
int ch_spi_configure (Cheetah cheetah, CheetahSpiPolarity polarity, CheetahSpiPhase phase, CheetahSpiBitorder bitorder, u08 ss_polarity)
int ch_spi_queue_array (Cheetah cheetah, int num_bytes, const u08 *data_out)
int ch_spi_queue_byte (Cheetah cheetah, int count, u08 data)
int ch_spi_queue_clear (Cheetah cheetah)
int ch_spi_queue_delay_cycles (Cheetah cheetah, int cycles)
int ch_spi_queue_delay_ns (Cheetah cheetah, int nanoseconds)
int ch_spi_queue_oe (Cheetah cheetah, u08 oe)
int ch_spi_queue_ss (Cheetah cheetah, u08 active)
const char * ch_status_string (int status)
int ch_target_power (Cheetah cheetah, u08 power_flag)
u32 ch_unique_id (Cheetah cheetah)
int ch_version (Cheetah cheetah, CheetahVersion *version)

Define Documentation

#define CH_DEBUG   0

Definition at line 98 of file cheetah.h.

#define CH_HEADER_VERSION   0x0300 /* v3.00 */

Definition at line 104 of file cheetah.h.

#define CH_HOST_IFCE_FULL_SPEED   0x00

Definition at line 373 of file cheetah.h.

#define CH_HOST_IFCE_HIGH_SPEED   0x01

Definition at line 374 of file cheetah.h.

#define CH_PORT_NOT_FREE   0x8000

Definition at line 227 of file cheetah.h.

#define CH_TARGET_POWER_OFF   0x00

Definition at line 364 of file cheetah.h.

#define CH_TARGET_POWER_ON   0x01

Definition at line 365 of file cheetah.h.

#define CH_TARGET_POWER_QUERY   0x80

Definition at line 366 of file cheetah.h.


Typedef Documentation

typedef int Cheetah

Definition at line 152 of file cheetah.h.

typedef struct CheetahExt CheetahExt

Definition at line 296 of file cheetah.h.

Definition at line 444 of file cheetah.h.

Definition at line 436 of file cheetah.h.

Definition at line 428 of file cheetah.h.

Definition at line 144 of file cheetah.h.

Definition at line 199 of file cheetah.h.


Enumeration Type Documentation

Enumerator:
CH_SPI_BITORDER_MSB 
CH_SPI_BITORDER_LSB 

Definition at line 439 of file cheetah.h.

Enumerator:
CH_SPI_PHASE_SAMPLE_SETUP 
CH_SPI_PHASE_SETUP_SAMPLE 

Definition at line 431 of file cheetah.h.

Enumerator:
CH_SPI_POL_RISING_FALLING 
CH_SPI_POL_FALLING_RISING 

Definition at line 423 of file cheetah.h.

Enumerator:
CH_OK 
CH_UNABLE_TO_LOAD_LIBRARY 
CH_UNABLE_TO_LOAD_DRIVER 
CH_UNABLE_TO_LOAD_FUNCTION 
CH_INCOMPATIBLE_LIBRARY 
CH_INCOMPATIBLE_DEVICE 
CH_INCOMPATIBLE_DRIVER 
CH_COMMUNICATION_ERROR 
CH_UNABLE_TO_OPEN 
CH_UNABLE_TO_CLOSE 
CH_INVALID_HANDLE 
CH_CONFIG_ERROR 
CH_UNKNOWN_PROTOCOL 
CH_STILL_ACTIVE 
CH_FUNCTION_NOT_AVAILABLE 
CH_OS_ERROR 
CH_SPI_WRITE_ERROR 
CH_SPI_BATCH_EMPTY_QUEUE 
CH_SPI_BATCH_SHORT_BUFFER 
CH_SPI_ASYNC_EMPTY 
CH_SPI_ASYNC_PENDING 
CH_SPI_ASYNC_MAX_REACHED 
CH_SPI_ASYNC_EXCESS_DELAY 

Definition at line 115 of file cheetah.h.


Function Documentation

int ch_close ( Cheetah  cheetah)

Definition at line 369 of file cheetah.c.

int ch_dev_addr ( Cheetah  cheetah)

Definition at line 483 of file cheetah.c.

int ch_find_devices ( int  num_devices,
u16 *  devices 
)

Definition at line 308 of file cheetah.c.

int ch_find_devices_ext ( int  num_devices,
u16 *  devices,
int  num_ids,
u32 *  unique_ids 
)

Definition at line 323 of file cheetah.c.

int ch_host_ifce_speed ( Cheetah  cheetah)

Definition at line 469 of file cheetah.c.

Cheetah ch_open ( int  port_number)

Definition at line 340 of file cheetah.c.

Cheetah ch_open_ext ( int  port_number,
CheetahExt ch_ext 
)

Definition at line 354 of file cheetah.c.

int ch_port ( Cheetah  cheetah)

Definition at line 383 of file cheetah.c.

u32 ch_sleep_ms ( u32  milliseconds)

Definition at line 440 of file cheetah.c.

int ch_spi_async_collect ( Cheetah  cheetah,
int  num_bytes,
u08 *  data_in 
)

Definition at line 680 of file cheetah.c.

int ch_spi_async_submit ( Cheetah  cheetah)

Definition at line 666 of file cheetah.c.

int ch_spi_batch_length ( Cheetah  cheetah)

Definition at line 636 of file cheetah.c.

int ch_spi_batch_shift ( Cheetah  cheetah,
int  num_bytes,
u08 *  data_in 
)

Definition at line 650 of file cheetah.c.

int ch_spi_bitrate ( Cheetah  cheetah,
int  bitrate_khz 
)

Definition at line 497 of file cheetah.c.

int ch_spi_configure ( Cheetah  cheetah,
CheetahSpiPolarity  polarity,
CheetahSpiPhase  phase,
CheetahSpiBitorder  bitorder,
u08  ss_polarity 
)

Definition at line 512 of file cheetah.c.

int ch_spi_queue_array ( Cheetah  cheetah,
int  num_bytes,
const u08 *  data_out 
)

Definition at line 620 of file cheetah.c.

int ch_spi_queue_byte ( Cheetah  cheetah,
int  count,
u08  data 
)

Definition at line 604 of file cheetah.c.

int ch_spi_queue_clear ( Cheetah  cheetah)

Definition at line 530 of file cheetah.c.

int ch_spi_queue_delay_cycles ( Cheetah  cheetah,
int  cycles 
)

Definition at line 559 of file cheetah.c.

int ch_spi_queue_delay_ns ( Cheetah  cheetah,
int  nanoseconds 
)

Definition at line 574 of file cheetah.c.

int ch_spi_queue_oe ( Cheetah  cheetah,
u08  oe 
)

Definition at line 544 of file cheetah.c.

int ch_spi_queue_ss ( Cheetah  cheetah,
u08  active 
)

Definition at line 589 of file cheetah.c.

const char* ch_status_string ( int  status)

Definition at line 411 of file cheetah.c.

int ch_target_power ( Cheetah  cheetah,
u08  power_flag 
)

Definition at line 454 of file cheetah.c.

u32 ch_unique_id ( Cheetah  cheetah)

Definition at line 397 of file cheetah.c.

int ch_version ( Cheetah  cheetah,
CheetahVersion version 
)

Definition at line 425 of file cheetah.c.



biotac_sensors
Author(s): Ian McMahon
autogenerated on Thu Aug 27 2015 12:35:30