img.h File Reference

Image header. More...

Go to the source code of this file.

Classes
struct	PmImgPaths_s
struct	PmCodeImgObj_s
Defines
#define	PM_NUM_IMG_PATHS   4
Typedefs
typedef struct PmImgPaths_s	PmImgPaths_t
typedef struct PmImgPaths_s *	pPmImgPaths_t
typedef struct PmCodeImgObj_s	PmCodeImgObj_t
typedef struct PmCodeImgObj_s *	pPmCodeImgObj_t
Functions
PmReturn_t	img_findInPaths (pPmObj_t pname, PmMemSpace_t *r_memspace, uint8_t const **r_imgaddr)
PmReturn_t	img_appendToPath (PmMemSpace_t memspace, uint8_t *paddr)

---

Detailed Description

Image header.

Created to eliminate a circular include among mem, string and obj.

---

Define Documentation

#define PM_NUM_IMG_PATHS   4

The maximum number of paths available in PmImgPaths

---

Typedef Documentation

typedef struct PmCodeImgObj_s PmCodeImgObj_t

Code image object

A type to hold code images in the heap. A code image with an object descriptor at the front. Used for storing image objects during ipm; the code object keeps a reference to this object.

---

Function Documentation

PmReturn_t img_appendToPath	(	PmMemSpace_t	memspace,
		uint8_t *	paddr
	)

Appends the given memspace and address to the image path array

Parameters:

	memspace	The memspace
	paddr	The address

Returns:

Return status

PmReturn_t img_findInPaths	(	pPmObj_t	pname,
		PmMemSpace_t *	r_memspace,
		uint8_t const **	r_imgaddr
	)

Iterates over all paths in the paths array until the named module is found. Returns the memspace,address of the head of the module.

Parameters:

	pname	Pointer to the name of the desired module
	r_memspace	Return by reference the memory space of the module
	r_imgaddr	Return by reference the address of the module's image

Returns:

Return status