/home/jaouen/pok_official/pok/trunk/kernel/include/core/partition.h

Go to the documentation of this file.

/*
 *                               POK header
 * 
 * The following file is a part of the POK project. Any modification should
 * made according to the POK licence. You CANNOT use this file or a part of
 * this file is this part of a file for your own project
 *
 * For more information on the POK licence, please see our LICENCE FILE
 *
 * Please follow the coding guidelines described in doc/CODING_GUIDELINES
 *
 *                                      Copyright (c) 2007-2009 POK team 
 *
 * Created by julien on Thu Jan 15 23:34:13 2009 
 */

#ifndef __POK_PARTITION_H__
#define __POK_PARTITION_H__

#ifdef POK_NEEDS_PARTITIONS

#include <types.h>
#include <errno.h>
#include <core/error.h>
#include <core/thread.h>
#include <core/sched.h>


typedef enum
{
   POK_PARTITION_MODE_INIT_COLD = 1, 
   POK_PARTITION_MODE_INIT_WARM = 2, 
   POK_PARTITION_MODE_NORMAL    = 3, 
   POK_PARTITION_MODE_IDLE      = 4, 
   POK_PARTITION_MODE_RESTART   = 5, 
   POK_PARTITION_MODE_STOPPED   = 6, 
}pok_partition_mode_t;

typedef enum
{
  NORMAL_START          = 0,
  PARTITION_RESTART     = 1,
  HM_MODULE_RESTART     = 2,
  HM_PARTITION_RESTART  = 3
}pok_start_condition_t;


typedef struct
{
   uint32_t              base_addr;    
   uint32_t              base_vaddr;   
   uint32_t              size;         
   const char            *name;        
   uint32_t              nthreads;     
   uint8_t               priority;     
   uint32_t              period;       
   pok_sched_t           sched;       
   uint32_t (*sched_func)(uint32_t low, uint32_t high,uint32_t prev_thread, uint32_t cur_thread); 
   uint64_t              activation;                    
   uint32_t              prev_thread;           
   uint32_t              current_thread;                
   uint32_t               thread_index_low;    
   uint32_t               thread_index_high;   
   uint32_t               thread_index;        
#if defined(POK_NEEDS_LOCKOBJECTS) || defined(POK_NEEDS_ERROR_HANDLING)
   uint8_t               lockobj_index_low;   
   uint8_t               lockobj_index_high;  
   uint8_t               nlockobjs;           
#endif

#ifdef POK_NEEDS_SCHED_HFPPS
   uint64_t             payback; 
#endif /* POK_NEEDS_SCHED_HFPPS */

#ifdef POK_NEEDS_ERROR_HANDLING
   uint32_t             thread_error;         
   pok_error_status_t   error_status;        
#endif
   uint32_t             thread_main;          
   uint32_t             thread_main_entry;    
   pok_partition_mode_t mode;                 
#ifdef POK_NEEDS_IO
  uint16_t              io_min;                        
  uint16_t              io_max;                        
#endif

  uint32_t              lock_level;
  pok_start_condition_t start_condition;
} pok_partition_t;

extern pok_partition_t pok_partitions[POK_CONFIG_NB_PARTITIONS];

#define POK_CURRENT_PARTITION pok_partitions[POK_SCHED_CURRENT_PARTITION]

#define POK_CHECK_PTR_IN_PARTITION(pid,ptr) (\
                                             ((((uint32_t)ptr)>=pok_partitions[pid].base_addr)&& \
                                             (((uint32_t)ptr)<=(pok_partitions[pid].base_addr+pok_partitions[pid].size)))?1:0\
                                             )

pok_ret_t pok_partition_init();

pok_ret_t pok_partition_set_mode (const uint8_t pid, const pok_partition_mode_t mode);
pok_ret_t pok_partition_set_mode_current (const pok_partition_mode_t mode);


pok_ret_t pok_partition_stop_thread (const uint32_t tid);

void pok_partition_reinit (const uint8_t);

void pok_partition_setup_main_thread (const uint8_t);

void pok_partition_setup_scheduler (const uint8_t pid);

pok_ret_t pok_partition_restart_thread (const uint32_t tid);

pok_ret_t pok_current_partition_get_id (uint8_t *id);

pok_ret_t pok_current_partition_get_period (uint64_t *period);

pok_ret_t pok_current_partition_get_duration (uint64_t *duration);

pok_ret_t pok_current_partition_get_operating_mode (pok_partition_mode_t *op_mode);

pok_ret_t pok_current_partition_get_lock_level (uint32_t *lock_level);

pok_ret_t pok_current_partition_get_start_condition (pok_start_condition_t *start_condition);

#endif /* __POK_NEEDS_PARTITIONS */

#endif /* __POK_PARTITION_H__ */