pynq.lib.pynqmicroblaze.pynqmicroblaze Module

class pynq.lib.pynqmicroblaze.pynqmicroblaze.MBInterruptEvent(intr_pin, intr_ack_gpio)

Bases: object

The class provides and asyncio Event-like interface to the interrupt subsystem for a Microblaze. The event is set by raising an interrupt and cleared using the clear function.

Typical use is to call clear prior to sending a request to the Microblaze and waiting in a loop until the response is received. This order of operations will avoid race conditions between the Microblaze and the host code.

clear()

Clear the interrupt and reset the event. Resetting the event should be done before sending a request that will be acknowledged interrupts.

async wait()

Coroutine to wait until the event is set by an interrupt.

class pynq.lib.pynqmicroblaze.pynqmicroblaze.MicroblazeHierarchy(description, mbtype='Unknown')

Bases: DefaultHierarchy

Hierarchy driver for the microblaze subsystem.

Enables the user to load programs on to the microblaze. All function calls and member accesses are delegated to the loaded program.

static checkhierarchy(description)

Function to check if the driver matches a particular hierarchy

This function should be redefined in derived classes to return True if the description matches what is expected by the driver. The default implementation always returns False so that drivers that forget don’t get loaded for hierarchies they don’t expect.

property mbtype

The defined type of the microblaze subsystem. Used by driver programs to limit what microblaze subsystems the program is run on.

class pynq.lib.pynqmicroblaze.pynqmicroblaze.PynqMicroblaze(mb_info, mb_program, force=False)

Bases: object

This class controls the active Microblaze instances in the system.

ip_name

The name of the IP corresponding to the Microblaze.

Type:

str

rst_name

The name of the reset pin for the Microblaze.

Type:

str

mb_program

The absolute path of the Microblaze program.

Type:

str

state

The status (IDLE, RUNNING, or STOPPED) of the Microblaze.

Type:

str

reset_pin

The reset pin associated with the Microblaze.

Type:

GPIO

mmio

The MMIO instance associated with the Microblaze.

Type:

MMIO

interrupt

An asyncio.Event-like class for waiting on and clearing interrupts.

Type:

Event

program()

This method programs the Microblaze.

This method is called in __init__(); it can also be called after that. It uses the attribute self.mb_program to program the Microblaze.

Return type:

None

read(offset, length=1)

This method reads data from the shared memory of Microblaze.

Parameters:

• offset (int) – The beginning offset where data are read from.

• length (int) – The number of data (32-bit int) to be read.

Returns:

An int of a list of data read from the shared memory.

Return type:

int/list

reset()

Reset the Microblaze to stop it from running.

This method will update the status of the Microblaze.

Return type:

None

run()

Start the Microblaze to run program loaded.

This method will update the status of the Microblaze.

Return type:

None

write(offset, data)

This method write data into the shared memory of the Microblaze.

Parameters:

• offset (int) – The beginning offset where data are written into.

• data (int/list) – A list of 32b words to be written.

Return type:

None

pynq.lib.pynqmicroblaze.compile Module

class pynq.lib.pynqmicroblaze.compile.MicroblazeProgram(mb_info, program_text, bsp=None)

Bases: PynqMicroblaze

pynq.lib.pynqmicroblaze.compile.checkmodule(name, mb_info)

pynq.lib.pynqmicroblaze.compile.dependencies(source, bsp)

pynq.lib.pynqmicroblaze.compile.preprocess(source, bsp=None, mb_info=None)

pynq.lib.pynqmicroblaze.compile.recursive_dependencies(source, bsp, current_set=None)

pynq.lib.pynqmicroblaze.rpc Module

class pynq.lib.pynqmicroblaze.rpc.ConstCharPointerWrapper(type_)

Bases: ConstPointerWrapper

Wrapper for const char*s which accepts Python strings and makes sure they are NULL-terminated

param_encode(old_val)

class pynq.lib.pynqmicroblaze.rpc.ConstPointerWrapper(type_, struct_string)

Bases: object

Wrapper for const T pointers, transfers data in only one direction.

param_decode(old_val, stream)

param_encode(old_val)

post_argument(name)

pre_argument(name)

return_decode(stream)

class pynq.lib.pynqmicroblaze.rpc.FuncAdapter(decl, typedefs)

Bases: object

Provides the C and Python interfaces for a function declaration

return_interface

The type wrapper for the return type

Type:

TypeWrapper

arg_interfaces

An array of type wrappers for the arguments

Type:

[TypeWrapper]

call_ast

Syntax tree for the wrapped function call

Type:

pycparser.c_ast

pack_args(*args)

Create a bytes of the provided arguments

receive_response(stream, *args)

Reads the response stream, updates arguments and returns the value of the function call if applicable

class pynq.lib.pynqmicroblaze.rpc.FuncDefVisitor

Bases: NodeVisitor

Primary visitor that parses out function definitions, typedes and enumerations from a syntax tree

visit_Enum(node)

visit_FuncDecl(node)

visit_FuncDef(node)

visit_Typedef(node)

exception pynq.lib.pynqmicroblaze.rpc.MicroblazeError

Bases: Exception

class pynq.lib.pynqmicroblaze.rpc.MicroblazeFunction(stream, index, function, return_type)

Bases: object

Calls a specific function

call(*args)

async call_async(*args)

class pynq.lib.pynqmicroblaze.rpc.MicroblazeLibrary(iop, libraries)

Bases: MicroblazeRPC

Provides simple Python-only access to a set of Microblaze libraries.

The members of this class are determined by the libraries chosen and can determined either by using dir on the instance or the ? operator inside of IPython

class pynq.lib.pynqmicroblaze.rpc.MicroblazeRPC(iop, program_text)

Bases: object

Provides a python interface to the Microblaze based on an RPC mechanism.

The attributes of the class are generated dynamically from the typedefs, enumerations and functions given in the provided source.

Functions are added as methods, the values in enumerations are added as constants to the class and types are added as classes.

release()

Alias for reset()

reset()

Reset and free the microblaze for use by other programs

class pynq.lib.pynqmicroblaze.rpc.ParsedEnum

Bases: object

Holds the values of an enum from the C source

class pynq.lib.pynqmicroblaze.rpc.PointerWrapper(type_, struct_string)

Bases: object

Wrapper for non-const T pointers that retrieves any data modified by the called function.

param_decode(old_val, stream)

param_encode(old_val)

post_argument(name)

pre_argument(name)

return_decode(stream)

class pynq.lib.pynqmicroblaze.rpc.PrimitiveWrapper(struct_string, type_)

Bases: object

Wrapper for C primitives that can be represented by a single Struct string.

param_decode(old_val, stream)

param_encode(old_val)

post_argument(name)

pre_argument(name)

return_decode(stream)

class pynq.lib.pynqmicroblaze.rpc.PyBoolWrapper(type_)

Bases: PrimitiveWrapper

return_decode(stream)

class pynq.lib.pynqmicroblaze.rpc.PyFloatWrapper(type_)

Bases: PrimitiveWrapper

return_decode(stream)

class pynq.lib.pynqmicroblaze.rpc.PyIntWrapper(type_)

Bases: PrimitiveWrapper

return_decode(stream)

class pynq.lib.pynqmicroblaze.rpc.PyVoidWrapper(type_)

Bases: PrimitiveWrapper

return_decode(stream)

class pynq.lib.pynqmicroblaze.rpc.VoidPointerWrapper(type_)

Bases: object

Wrapper for a void* pointer that will refer to a physically contiguous chunk of memory.

param_decode(old_val, stream)

param_encode(old_val)

post_argument(name)

pre_argument(name)

return_decode(stream)

class pynq.lib.pynqmicroblaze.rpc.VoidWrapper

Bases: object

Wraps void - only valid for return types

param_decode(old_val, stream)

param_encode(old_val)

post_argument(name)

pre_argument(name)

return_decode(stream)

pynq.lib.pynqmicroblaze.magic Module

class pynq.lib.pynqmicroblaze.magic.MicroblazeMagics(**kwargs: Any)

Bases: Magics

magics = {'cell': {'microblaze': 'microblaze'}, 'line': {}}

microblaze(line, cell)

name2obj(name)

registered = True

pynq.lib.pynqmicroblaze.streams Module

class pynq.lib.pynqmicroblaze.streams.InterruptMBStream(iop, read_offset=62464, write_offset=61440)

Bases: SimpleMBStream

async read_async()

async wait_for_data_async()

class pynq.lib.pynqmicroblaze.streams.SimpleMBChannel(buffer, offset=0, length=0)

Bases: object

buffer_space()

bytes_available()

read(n=-1)

read_upto(n=-1)

write(b)

class pynq.lib.pynqmicroblaze.streams.SimpleMBStream(iop, read_offset=62464, write_offset=61440)

Bases: object

buffer_space()

bytes_available()

read(n=-1)

read_byte()

read_float()

read_int16()

read_int32()

read_string()

read_uint16()

read_uint32()

write(b)

write_address(p, adjust=True)

write_byte(b)

write_float(f)

write_int16(i)

write_int32(i)

write_string(s)

write_uint16(u)

write_uint32(u)

pynq.lib.pynqmicroblaze.bsp Module

class pynq.lib.pynqmicroblaze.bsp.BSPInstance(root)

Bases: object

class pynq.lib.pynqmicroblaze.bsp.Module(root)

Bases: object

pynq.lib.pynqmicroblaze.bsp.add_bsp(directory)

pynq.lib.pynqmicroblaze.bsp.add_module_path(directory)