The function returns low byte of param. The function does not interpret bit patterns of param – it merely returns 8 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• param: input number.

Low byte of param, bits 7..0.

Nothing.

d = 0x12345678; 	
tmp = Lo(d);  // Equals 0x78

Lo(d) = 0xAA; // d equals 0x123456AA

None.

The function returns high byte of param. The function does not interpret bit patterns of param – it merely returns 8 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• param: input number.

High byte of param, bits 15..8.

Nothing.

d = 0x12345678; 	
tmp = Hi(d);  // Equals 0x56

Hi(d) = 0xAA; // d equals 0x1234AA78

None.

The function returns higher byte of param. The function does not interpret bit patterns of param – it merely returns 8 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• param: input number.

Higher byte of param, bits 23..16.

Nothing.

d = 0x12345678; 	
tmp = Higher(d);  // Equals 0x34

Higher(d) = 0xAA; // d equals 0x12AA5678

None.

The function returns highest byte of param. The function does not interpret bit patterns of param – it merely returns 8 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• param: input number.

Highest byte of param, bits 31..24.

Nothing.

d = 0x12345678; 	
tmp = Highest(d);  // Equals 0x12

Highest(d) = 0xAA; // d equals 0xAA345678

None.

The function returns low word of param. The function does not interpret bit patterns of param – it merely returns 16 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• param: input number.

Low word of param, bits 15..0.

Nothing.

d = 0x12345678; 	
tmp = LoWord(d);  // Equals 0x5678

LoWord(d) = 0xAAAA; // d equals 0x1234AAAA

None.

The function returns high word of param. The function does not interpret bit patterns of param – it merely returns 16 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• param: input number.

High word of param, bits 31..16.

Nothing.

d = 0x12345678; 	
tmp = HiWord(d);  // Equals 0x1234

HiWord(d) = 0xAAAA; // d equals 0xAAAA5678

None.

The function returns low longword of param. The function does not interpret bit patterns of param – it merely returns 32 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• param: input number.

Low longword of param, bits 31..0.

Nothing.

d = 0x1122334455667788;
tmp = LoLongWord(d);  // Equals 0x55667788

LoLongWord(d) = 0xAAAAAAAA; // d equals 0x11223344AAAAAAAA

None.

The function returns high longword of param. The function does not interpret bit patterns of param – it merely returns 32 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• param: input number.

High word of param, bits 63..32.

Nothing.

d = 0x1122334455667788;
tmp = HiLongWord(d);  // Equals 0x11223344

HiLongWord(d) = 0xAAAAAAAA; // d equals 0xAAAAAAAA55667788

None.

Creates a software delay in duration of time_in_us microseconds.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• time_in_us: delay time in microseconds. Valid values: constant values, range of applicable constants depends on the oscillator frequency

Nothing.

Nothing.

Delay_us(10);  /* Ten microseconds pause */

None.

Creates a software delay in duration of time_in_ms milliseconds.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• time_in_ms: delay time in milliseconds. Valid values: constant values, range of applicable constants depends on the oscillator frequency

Nothing.

Nothing.

Delay_ms(1000);  /* One second pause */

For generating delays with variable as input parameter use the Vdelay_ms routine.

Creates a software delay in duration of Time_ms milliseconds. Generated delay is not as precise as the delay created by Delay_ms.

• Time_ms: delay time in milliseconds

Nothing.

Nothing.

unsignedpause = 1000;
...
Vdelay_ms(pause);  // ~ one second pause

Vdelay_ms is a library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

Creates a software delay in duration of time_in_ms milliseconds (a variable), for a given oscillator frequency. Generated delay is not as precise as the delay created by Delay_ms.

• Time_ms: delay time in milliseconds
• Current_Fosc_kHz: desiredoscillator frequency

Nothing.

Nothing.

pause = 1000;
fosc = 10000;

VDelay_Advanced_ms(pause, fosc);  // Generates approximately one second pause, for a oscillator frequency of 10 MHz

Note that VDelay_Advanced_ms is library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

Creates a delay based on MCU clock. Delay lasts for x*16384 + y MCU clock cycles.

• x: NumberOfCycles divided by 16384
• y: remainder of the NumberOfCycles/16384 division

Nothing.

Nothing.

Delay_Cyc(1, 10);  /* 1x16384 + 10 = 16394 cycles pause */

Delay_Cyc is a library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

Creates a delay based on MCU clock. Delay lasts for CycNo MCU clock cycles.

• CycNo: number of cycles

Nothing.

Nothing.

Delay_Cyc_Long(16394);  // 16394 cycles pause

Delay_Cyc_Long is a library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

Function returns device clock in kHz, rounded to the nearest integer.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

None.

Device clock in kHz, rounded to the nearest integer.

Nothing.

unsigned long clk;
...
clk = Clock_kHz();

None.

Function returns device clock in MHz, rounded to the nearest integer.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

None.

Device clock in MHz, rounded to the nearest integer.

Nothing.

unsigned long clk;
...
clk = Clock_Mhz();

None.

Function returns device clock in kHz, rounded to the nearest integer.

Note that Get_Fosc_kHz is library function rather than a built-in routine; it is presented in this topic for the sake of c?nvenience.

None.

Device clock in kHz, rounded to the nearest integer.

Nothing.

unsigned long clk;
...
clk = Get_Fosc_kHz();

None.

Function returns device's clock per cycle, rounded to the nearest integer.

Note that Get_Fosc_Per_Cyc is library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

None.

Device's clock per cycle, rounded to the nearest integer.

Nothing.

unsigned int clk_per_cyc;
...
clk_per_cyc = Get_Fosc_Per_Cyc();

None.

Function converts virtual address from KSEG0 to the virtual address in the KSEG1.

Desired Virtual address in the KSEG0.

Virtual address in the KSEG1.

Nothing.

KVA0_TO_KVA1(0x9FC00000);

None.

Function converts virtual address from KSEG1 to the virtual address in the KSEG0.

Desired Virtual address in the KSEG1.

Virtual address in the KSEG0.

Nothing.

KVA1_TO_KVA0(0xBFC00000);

None.

Function converts virtual address from any Kernel segment to the appropriate physical address.

Desired Virtual Address.

Appropriate physical address.

Nothing.

KVA_TO_PA(0xBFC00000);

None.

Function converts physical address to the virtual address in the KSEG0.

Desired physical address.

Appropriate virtual address in the KSEG0.

Nothing.

PA_TO_KVA0(0x1D000000);

None.

Function converts physical address to the virtual address in the KSEG1.

Appropriate virtual address in the KSEG1.

Virtual address in the KSEG1.

Nothing.

PA_TO_KVA1(0x1D000000);

None.

Function returns the value of the coprocessor register or part of the register, based upon the argument entered.

Parameter must be a constant from the enumerated built-in constants list, which can be found at the bottom of this page.

Value of the coprocessor register or part of the register.

Nothing.

unsigned long register_value;

register_value = CP0_GET(CP0_CONFIG);

None.

Function sets the value of the coprocessor register or part of the register, based upon the register argument.

• register: Register or register part, must be a constant from the enumerated built-in constants list, which can be found at the bottom of this page.
• value: Register Value.

Nothing.

Nothing.

CP0_SET(CP0_CONFIG, 0x1A2C0000);

None.

Restores (enables or disables) interrupt flag based on the last STATUS register value given as a routine parametar.

If the STATUS.B0 = 1 interrupts are enabled, if not, interrupts are disabled.

None.

Returns the value stored in the STATUS register before the interrupts were enabled/disabled.

Nothing.

None.

Function enables interrupts.

None.

Returns the value stored in the STATUS register before the interrupts were enabled/disabled.

Nothing.

status_value = EI();

None.

Function enables interrupts.

None.

Returns the value stored in the STATUS register before the interrupts were enabled/disabled.

Nothing.

EnableInterrupts();

None.

Function disables interrupts.

None.

Returns the value stored in the STATUS register before the interrupts were enabled/disabled.

Nothing.

DisableInterrupts();

None.

Function disables interrupts.

Returns the value stored in the STATUS register before the interrupts were enabled/disabled.

Nothing.

Nothing.

DisableInterrupts();

None.

This procedure is equal to assembler instruction reset.

None.

Nothing.

Nothing.

Reset(); // Resets the MCU

None.

Function suspends the DMA controller.

None.

• 1 if the DMA was previously suspended.
• 0 otherwise.

Nothing.

This routine is used only if the MCU possesses the DMA controller.

Restores the DMA controller activity to the previous, suspended state.

• susp: desired DMA suspended state.

Nothing.

Nothing.

This routine is used only if the MCU possesses the DMA controller.

Procedure unlocks the system, setting the interrupts disabled and the DMA operation suspended.

• intStat: desired DMA state.
• dmaSusp: desired interrupt state.

Nothing.

Nothing.

If the DMA controller is not present, the dmaSusp parameter doesn't exist.

Procedure locks the system, setting the interrupts and the DMA controller from the passed parameters.

• intStat: desired DMA state.
• dmaSusp: desired interrupt state.

Nothing.

Nothing.

If the DMA controller is not present, the dmaSusp parameter doesn't exist.