openMMC
Open Source Modular MMC for AMCs
Loading...
Searching...
No Matches
AFCv3.1 Payload Control
Collaboration diagram for AFCv3.1 Payload Control:

Topics

 Payload Messages Codes
 

Macros

#define PAYLOAD_BASE_DELAY   100
 Payload task unblock delay.
 

Enumerations

enum  {
  PAYLOAD_NO_POWER = 0 , PAYLOAD_POWER_GOOD_WAIT , PAYLOAD_STATE_FPGA_SETUP , PAYLOAD_FPGA_ON ,
  PAYLOAD_SWITCHING_OFF , PAYLOAD_QUIESCED , PAYLOAD_RESET , PAYLOAD_MAX_STATES
}
 Payload state machine state numbers. More...
 

Functions

void payload_send_message (uint8_t fru_id, EventBits_t msg)
 Sends a message to the payload task.
 
void vTaskPayload (void *pvParameters)
 Payload Control task.
 
void payload_init (void)
 Creates Payload Control task and initializes the board's needed hardware.
 
mmc_err clock_configuration (const uint8_t clk_cfg[16])
 Configure the clock switch interconects according to the configuration saved in EEPROM.
 

Variables

enum { ... }  payload_state
 Payload state machine state numbers.
 
TaskHandle_t vTaskPayload_Handle
 Payload task handle variable.
 

Detailed Description

Macro Definition Documentation

◆ PAYLOAD_BASE_DELAY

#define PAYLOAD_BASE_DELAY   100

#include <port/board/afc-v3/payload.h>

Payload task unblock delay.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

#include <port/board/afc-v3/payload.h>

Payload state machine state numbers.

Enumerator
PAYLOAD_NO_POWER 
PAYLOAD_POWER_GOOD_WAIT 
PAYLOAD_STATE_FPGA_SETUP 
PAYLOAD_FPGA_ON 
PAYLOAD_SWITCHING_OFF 
PAYLOAD_QUIESCED 
PAYLOAD_RESET 
PAYLOAD_MAX_STATES 

Function Documentation

◆ clock_configuration()

mmc_err clock_configuration ( const uint8_t clk_cfg[16])

#include <port/board/afc-v3/payload.h>

Configure the clock switch interconects according to the configuration saved in EEPROM.

◆ payload_init()

void payload_init ( void )

#include <port/board/afc-v3/payload.h>

Creates Payload Control task and initializes the board's needed hardware.

◆ payload_send_message()

void payload_send_message ( uint8_t fru_id,
EventBits_t msg )

#include <port/board/afc-v3/payload.h>

Sends a message to the payload task.

This function basically sets a flag that the Payload task reads and advances (or not) on the state machine

Parameters
fru_idTarget FRU ID (0:AMC 1:RTM)
msgMessage to send, using Payload Messages Codes definitions

◆ vTaskPayload()

void vTaskPayload ( void * pvParameters)

#include <port/board/afc-v3/payload.h>

Payload Control task.

Parameters
pvParametersPointer to buffer holding parameters passed to task upon initialization

Variable Documentation

◆ []

enum { ... } payload_state

#include <port/board/afc-v3/payload.h>

Payload state machine state numbers.

◆ vTaskPayload_Handle

TaskHandle_t vTaskPayload_Handle
extern

#include <port/board/afc-v3/payload.h>

Payload task handle variable.