device/types.h header reference
[Devices support library module]

The source code of this header can be browsed online.

Description  

Device related types

Members  

Types  

Functions  

Constant  

Macros  

Members detail  

#define DEV_FREQ(freq_num_, freq_denom_, acc_m_, acc_e_)  

This macro is declared in device/types.h source file, line 108.

This macro encodes a frequency and its accuracy

See also struct dev_freq_s.

#define DEV_FREQ_ACC(m_, e_)  

This macro is declared in device/types.h source file, line 105.

This macro encodes a frequency accuracy value

See also struct dev_freq_s.

#define DEV_FREQ_ACC_IS_VALID(a)  

This macro is declared in device/types.h source file, line 117.

This macro tests if the frequency accuracy value is valid

See also struct dev_freq_s.

#define DEV_FREQ_INVALID  

This macro is declared in device/types.h source file, line 99.

This macro encodes the invalid frequency value .

See also struct dev_freq_s.

#define DEV_FREQ_IS_VALID(f)  

This macro is declared in device/types.h source file, line 102.

This macro tests if the frequency value is valid .

See also struct dev_freq_s.

#define __DEVICE_TYPES_H__  

This macro is declared in device/types.h source file, line 23.

This function is declared in device/types.h source file, line 121.

uint32_t dev_freq_acc_ppb(const struct dev_freq_s *freq)  

This function is declared in device/types.h source file, line 131.

void dev_freq_acc_set(struct dev_freq_s *freq, uint8_t acc_m, uint8_t acc_e)  

This function is declared in device/types.h source file, line 136.

struct dev_freq_ratio_s  

This struct is declared in device/types.h source file, line 143.

Clock ratio

FieldDescription
uint32_t num:CONFIG_DEVICE_CLOCK_FRAC_WIDTH;
uint32_t denom:CONFIG_DEVICE_CLOCK_FRAC_WIDTH;

struct dev_freq_s  

This struct is declared in device/types.h source file, line 92.

Clock frequency in Hz = num / denom. The invalid frequency is encoded by setting denom to 0.

Clock frequency accuracy in ppb. The value in ppb is (8 | m) * 2^(e-4).

The invalid accuracy value is encoded by setting e to 0.

See also DEV_FREQ_ACC, DEV_FREQ_INVALID, DEV_FREQ_IS_VALID and DEV_FREQ_ACC_IS_VALID.

FieldDescription
uint64_t num:CONFIG_DEVICE_CLOCK_OSCN_WIDTH;
uint64_t denom:CONFIG_DEVICE_CLOCK_OSCD_WIDTH;
uint64_t acc_m:3;
uint64_t acc_e:5;

const char dev_pin_driving_e[]  

This variable is declared in ENUM_DESCRIPTOR function like macro expansion, line 1 in device/types.h source file, line 35.

Alternate declarations with same identifier: [1], [2].

enum dev_pin_driving_e  

This enum is declared in device/types.h source file, line 39.

This enum specifies IO signal driving modes

Alternate declarations with same identifier: [1], [2].

IdentifierDescription
DEV_PIN_DISABLED
DEV_PIN_ENABLED_
DEV_PIN_RESISTOR_UP_
DEV_PIN_RESISTOR_DOWN_
DEV_PIN_DRIVE_UP_
DEV_PIN_DRIVE_DOWN_
DEV_PIN_PUSHPULLOutput (symbol: >). DEV_PIN_ENABLED_ | DEV_PIN_DRIVE_UP_ | DEV_PIN_DRIVE_DOWN_
DEV_PIN_INPUTInput (symbol: <). DEV_PIN_ENABLED_
DEV_PIN_INPUT_PULLInput with pull resistor, pull direction depends on output value (symbol: =). DEV_PIN_ENABLED_ | DEV_PIN_RESISTOR_UP_ | DEV_PIN_RESISTOR_DOWN_
DEV_PIN_INPUT_PULLUPInput with pullupup resistor (symbol: +.). DEV_PIN_ENABLED_ | DEV_PIN_RESISTOR_UP_
DEV_PIN_INPUT_PULLDOWNInput with pullupdown resistor (symbol: -). DEV_PIN_ENABLED_ | DEV_PIN_RESISTOR_DOWN_
DEV_PIN_OPENDRAINOpen drain output (symbol: _). DEV_PIN_ENABLED_ | DEV_PIN_DRIVE_DOWN_
DEV_PIN_OPENSOURCEOpen source output (symbol: ^). DEV_PIN_ENABLED_ | DEV_PIN_DRIVE_UP_
DEV_PIN_OPENDRAIN_PULLUPOpen drain output with pullup resistor (symbol: ,). DEV_PIN_ENABLED_ | DEV_PIN_DRIVE_DOWN_ | DEV_PIN_RESISTOR_UP_
DEV_PIN_OPENSOURCE_PULLDOWNOpen source output with pulldown resistor (symbol: `). DEV_PIN_ENABLED_ | DEV_PIN_DRIVE_UP_ | DEV_PIN_RESISTOR_DOWN_

Valid XHTML 1.0 StrictGenerated by diaxen on Wed Oct 17 21:18:38 2018 using MkDoc