spin1_api_params.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2011 The University of Manchester
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __SPINN_API_PARAM_H__
#define __SPINN_API_PARAM_H__
 
 
// ------------------------------------------------------------------------
// internal constants and parameters -- not visible in the API
// ------------------------------------------------------------------------
// ---------------------
/* simulation control */
// ---------------------
#if 0 // DKF: are these unused?
/* synchronization barrier key and mask codes */
#define GO_KEY                (uint) ((0x1ffff << 11) | 0)
#define RDYGO_KEY             (uint) ((0x1ffff << 11) | 1)
#define RDY1_KEY              (uint) ((0x1ffff << 11) | 2)
#define RDY2_KEY              (uint) ((0x1ffff << 11) | 3)
#define BARRIER_MASK          (uint) (0xffffffff)
 
#define BARRIER_GO_WAIT       50000
#define BARRIER_RDY2_WAIT     25000
#define BARRIER_RDYGO_WAIT    25000
#define BARRIER_LOCK_WAIT     50000
#define BARRIER_RESEND_WAIT   100
 
#define ROUTER_INIT_WAIT      5000
 
/* lock usage */
#define CLEAR_LCK             0
#define RTR_INIT_LCK          0xad
#define RDYGO_LCK             0xbe
#endif
 
enum spin1_api_link_orientations {
    EAST =                0,
    NORTH_EAST =          1,
    NORTH =               2,
    WEST =                3,
    SOUTH_WEST =          4,
    SOUTH =               5
};
 
#define API_WARN              TRUE
#define API_DEBUG             TRUE
#define API_DIAGNOSTICS       TRUE
#define NON_ROOT              FALSE
#define API_PRINT_DLY         200
 
enum spin1_api_error_codes {
    NO_ERROR =            0,
    TASK_QUEUE_FULL =     1,
    DMA_QUEUE_FULL =      2,
    PACKET_QUEUE_FULL =   4,
    WRITE_BUFFER_ERROR =  8,
    SYNCHRO_ERROR =      16
};
// --------------------------------
 
// ----------------
/* data transfer */
// ----------------
//TODO: may need adjustment for SpiNNaker
#define DMA_BURST_SIZE        4
#define DMA_WIDTH             1
#define DMA_QUEUE_SIZE        16
#define USE_WRITE_BUFFER      FALSE
// ---------------------------
 
// -----------------
// communications */
// -----------------
#define TX_PACKET_QUEUE_SIZE  16
// TX control register programming
#define TX_TCR_MCDEFAULT      0x00000000
#define TX_FULL_MASK          0x40000000
#define TX_EMPTY_MASK         0x80000000
#define RX_RECEIVED_MASK      0x80000000
// -----------------
 
// --------------
/* user events */
// --------------
#define USER_EVENT_QUEUE_SIZE 4
 
// --------------------
/* memory allocation */
// --------------------
#define RTS_STACKS            4096
// --------------------
 
// -----------------------
/* scheduler/dispatcher */
// -----------------------
enum spin1_api_callback_queue_params {
    N_TASK_QUEUES = 4,    
    NUM_PRIORITIES =  5,  
    TASK_QUEUE_SIZE = 16  
};
// -----------------------
 
// -----------------------
// -----------------------
 
enum spin1_api_multicast_entries {
    SYS_MC_ENTRIES = 1,
    APP_MC_ENTRIES = (MC_TABLE_SIZE - SYS_MC_ENTRIES)
};
 
// -----------------------
// -----------------------
enum spin1_api_vic_priorties {
    SARK_PRIORITY =        0,   
    TIMER2_PRIORITY =      1,   
    TIMER1_PRIORITY =      2,   
    DMA_DONE_PRIORITY =    3,   
    RX_READY_PRIORITY =    4,   
    FR_READY_PRIORITY =    5,   
    CC_TMT_PRIORITY =      6,   
    SOFT_INT_PRIORITY =    7,   
#if USE_WRITE_BUFFER == TRUE
    DMA_ERR_PRIORITY =     8    
#endif
};
 
// ------------------------------------------------------------------------
 
// ------------------------------------------------------------------------
// helpful macros
// ------------------------------------------------------------------------
#define CHIP_ADDR(x, y)      ((x << 8) | y)
#define P2P_ROUTE(addr)      (1 << p2p_get(addr))
#define CORE_ROUTE(core)     (1 << (core + NUM_LINKS))
// ------------------------------------------------------------------------
 
// ------------------------------------------------------------------------
// internal pre-defined types -- not visible in the API
// ------------------------------------------------------------------------
// ----------------
/* data transfer */
// ----------------
typedef struct {
    uint id;                    
    uint tag;                   
    uint* system_address;       
    uint* tcm_address;          
    uint description;           
} copy_t;
 
typedef struct {
    uint start;                 
    uint end;                   
    copy_t queue[DMA_QUEUE_SIZE];
} dma_queue_t;
// ----------------
 
// -----------------
/* communications */
// -----------------
typedef struct {
    uint key;                   
    uint data;                  
    uint TCR;                   
} packet_t;
 
typedef struct {
    uint start;                 
    uint end;                   
    packet_t queue[TX_PACKET_QUEUE_SIZE];
} tx_packet_queue_t;
// -----------------
 
// --------------
/* user events */
// --------------
typedef struct {
    uint arg0;                  
    uint arg1;                  
} user_event_t;
 
typedef struct {
    uint start;                 
    uint end;                   
    user_event_t queue[USER_EVENT_QUEUE_SIZE];
} user_event_queue_t;
 
// -----------------------
/* scheduler/dispatcher */
// -----------------------
typedef struct {
    callback_t cback;           
    int priority;               
} cback_t;
 
typedef struct {
    callback_t cback;           
    uint arg0;                  
    uint arg1;                  
} task_t;
 
typedef struct {
    uint start;                 
    uint end;                   
    task_t queue[TASK_QUEUE_SIZE];
} task_queue_t;
 
extern cback_t callback[NUM_EVENTS];
 
#ifdef __GNUC__
typedef void (*isr_t) (void);
#else
typedef __irq void (*isr_t) (void);
#endif
// ------------------------------------------------------------------------
 
// ------------------------------------------------------------------------
// internal variables -- not visible in the API
// ------------------------------------------------------------------------
static volatile isr_t * const vic_vectors  = (isr_t *) (VIC_BASE + 0x100);
static volatile uint * const vic_controls = (uint *) (VIC_BASE + 0x200);
 
// ------------------------------------------------------------------------
 
#endif /* __SPINN_API_PARAM_H__ */